[AI71]Obtain Offline Report

post
https://connect.patsnap.com/ai/sso/agent/export-link
Try in Sandbox

This interface serves as an optimized function for the AI API, supporting users in integrating report links into their local systems. The Agents that currently support outputting report links are: [AI32] Technology Disclosure Document, [AI35] Novelty Check, [AI37] Patent Drafting (CNIPA), and [AI66] FTO Search.

Currently, this interface only supports IP-type Agents and retrieves report links. This interface supports batch requests for task_id, with an upper limit of 5. If using start_time and end_time to retrieve report links, it will by default return only the first 5 task IDs; email and phone must have at least one non-empty value

Request Parameters

List of parameters supported by this API endpoint

NameTypeExampleDescription
agent_type
Required
stringai_novelty_search
Agent type, used to filter specific types of Agent records. Supported types:

ai_patent_disclosure - [AI32] Patent Disclosure

ai_specification - [AI37] Patent Drafting

ai_fto_search - [AI66]AI FTO Search

ai_novelty_search - [AI35] AI Novelty Search

company_id
Required
stringabc123
Company ID
email
stringuser@example.com
User email
end_time
integer<int64>1761580799999
End timestamp (milliseconds)
lang
Required
stringCN
language CN / EN / TW / JP
page
integer<int32>1
Page number, starting from 1
phone
string12345678900
phone number
start_time
integer<int64>1758902400000
Start timestamp (milliseconds)
task_id_list
array[ "task_id_1", "task_id_2" ]
Task ID list, if provided, use these task IDs directly to get export links, otherwise query history records based on other conditions. Maximum 5 task IDs supported

Response Schema

Structure of the API response data

Field NameTypeExampleDescription
data
object-
response data
items
array[ { "url": "https://qa-patsnap-import-workspace.cdn.zhihuiya.com/agent/reports/technical_solution_20251023.docx", "task_id": "task01", "file_name": "Technical_Solution_Exploration_20251023.docx" }, { "url": "https://qa-patsnap-import-workspace.cdn.zhihuiya.com/agent/reports/technical_solution_20251023.pdf", "task_id": "task02", "file_name": "Technical_Solution_Exploration_20251023.pdf" } ]
List of export links
url
stringhttps://qa-patsnap-import-workspace.cdn.zhihuiya.com/agent/reports/technical_solution_20251023.docx
Export file download URL
task_id
stringda5eb754-ec87-4a8b-9525-7108b0a76fad
Task ID
file_name
stringTechnical_Solution_Exploration_20251023.docx
Export file name
status
Required
booleanfalse
Status
error_msg
stringThe request parameter format is incorrect!
Error Message
error_code
Required
integer0
Error Code

Success Response Example

Example of a successful API response

JSON
{
  "data": {
    "items": [
      {
        "url": "https://qa-patsnap-import-workspace.cdn.zhihuiya.com/agent/reports/technical_solution_20251023.docx",
        "task_id": "da5eb754-ec87-4a8b-9525-7108b0a76fad",
        "file_name": "Technical_Solution_Exploration_20251023.docx"
      }
    ]
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error CodeDescription
68300004Invalid parameter!
68300005Search api failure!
68300006Analytic basic access error!
68300007Bad request!
68300008Service error, please try again later!
68300010The file does not comply with upload specifications!

Platform Errors

Error CodeDescription
67200000API call exceeds the total limit set by the platform!
67200001API call exceeds the total limit set by the platform!
67200002The current call rate is too fast, exceeding the current configuration limit QPS!
67200003The key and secret parameters for applying for the token are incorrect or the client has been disabled!
67200004The requested api does not have permission. Please contact our support personnel!
67200005Insufficient account balance/number of calls!
67200006The client has exceeded the activation validity period!
67200007The current call exceeds the configured usage limit of the day!
67200008Please check if the required apikey in the query parameter has been transmitted!
67200009The apikey does not match the passed bearerToken. Please check if a valid token is being used!
67200012The request is illegal!
67200100The current server status is busy, request response timeout!
67200101The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status CodeDescription
0Success
201Created
401Unauthorized
403Forbidden
404Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms