Ask questions to Copilot

POST 
/wiki/ask

History

Version	Changes
v6.35.0	Added in: v6.35.0

Request

Query Parameters

teamID stringrequired

The team ID

requestUserID string

User ID, this parameter can only be passed when calling as an Oauth bot. It is used to perform operations as the specified user

application/json

Body

required

The question to ask Copilot and other parameters.

oneOf

MOD1

start a new Copilot ask request.

scopeType string

Possible values: [global, space, page, attachment]

the type of scopeID, default is global

scopeID string

the ID of the pre-defined scopeType, may be SpaceID, PageID or AttachmentID. When scopeType is global, it is not required.

query string

The question/request sent to Copilot.

language string

The output language of the response, default is current user's language. The value should be a valid English name of the language, such as "Chinese", "English", "Japanese", etc.

generateRelatedQuestions boolean

Whether to generate related questions, default is true.

config

object

configurations to run the ask request

expandQuery boolean

Whether to expand the query before searching the vector database. Query expansion will make the result more relevant, but may increase latency. For this options to work, the LLM models must support structured data generation. Default value for reasoning model is false, for other models is true.

enableCache boolean

Whether to enable cache for the ask request. Default is true.

MOD2

continue a Copilot ask request, the requestID is required.

query string

The question/request sent to Copilot.

conversationID string

The ID of the conversation to continue, required when continuing a Copilot ask request.

Responses

200

Data will be returned in SSE format

If any error occurs, the response will have the following error codes:

Code	Error
409	Exceed copilot usage quota. Premise deployment has no usage quota limitation
510	Generic Copilot error
511	No Copilot license
512	Copilot is not installed
513	Invalid request parameters, refer to the error message for details
601	Authorization error when calling external AI services
602	Exceed quota error when calling external AI services
604	Cannot connect to external AI services
605	Permission denied when calling external AI Services

text/event-stream

Schema

Schema

oneOf

MOD1

step type response, indicating the current step of the Copilot process.

type string

Possible values: [step]

step string

Possible values: [embedding, searching, reranking, thinking, generating]

MOD2

Reasoning process response. Only returned when the COpilot is configured with a reasoning model.

type string

Possible values: [reasoning]

reasoning string

The reasoning token from Copilot.

reasoningTimeCost integer

The time cost of the reasoning process in milliseconds.

MOD3

Answer/response process.

type string

Possible values: [generating]

content string

The content of the response from Copilot.

MOD4

Related questions response.

type string

Possible values: [relatedQuestions]

questions string[]

The related questions generated by Copilot.

MOD5

Generation end response.

type string

Possible values: [generationEnd]

content string

The full content of the response from Copilot.

reasoning string

The full reasoning content from Copilot, if available.

reasoningTimeCost integer

The total time cost of the reasoning process in milliseconds, if applicable.

references

object[]

The references used in the response, the first one is referenced in response as [info1], the second one is referenced as [info2], and so on.

Array [

contentType string

Possible values: [page, media, attachment]

The type of content, such as 'page' or 'media' or 'attachment'.

itemID string

The ID of the item, such as PageID or AttachmentID.

fileName string

The name of the file, if contentType is 'media'

]

attachments

object[]

The attachment information used in references

Array [

name string

The name of the attachment.

pageName string

The name of the page where the attachment is located.

pageID string

The ID of the page where the attachment is located.

spaceID string

The ID of the space where the page is located.

ID string

The ID of the attachment. Used by reference itemID to identify the attachment.

]

pages

object[]

The page information used in references

Array [

name string

The title of the page.

ID string

The ID of the page. Used by reference itemID to identify the page.

spaceID string

The ID of the space where the page is located.

spaceName string

The name of the space where the page is located.

]

MOD6

End response.

type string

Possible values: [end]

conversationID string

The ID of the conversation, used to continue the conversation in the future.

code integer

The error code, 0 for success, other values indicate an error (see above error codes table).

message string

The error message.

Example (from schema)

{}

401

Returned if the authentication credentials are incorrect or missing.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

Returns if the scope check fails.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

Returned if the resource object was not found.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

Internal Server Error.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

Loading...