Copilot Hub Open API Access Doc

Workflow

Create a Copilot on Copilot Hub.

2.
Get the API key from Integration module of Copilot Dashboard. ​

common.docs_name - LarkCCM_Docs_Menu_Image

3.
Use our API Endpoint to integrate corresponding Copilot into your own apps​

API Endpoint

Use https://api.copilothub.ai/openapi/v1/query to call our copilot service for query

代码块

curl --location --request POST 'https://api.copilothub.ai/openapi/v1/query' \​
--header 'Content-Type: application/json' \​
--data-raw '{​
    "api_key":"XXX",​
    "query":"Hello"​
}'​

Method：POST

Body

Response

Example:

代码块

{​
    "result": "Hello! How can I assist you today?",​
    "sources": [​
        "2304.01852.pdf"​
    ],​
    "quota": 798,​
    "default_quota": 800,​
    "package_quota": 100​
}​

Error Status Code

Copilot Hub Open API Access Doc​

Copilot Hub Open API Access Doc