assistants

Scout API 1.0.0 — see schemas for shared types.

GET /api/assistants

get_assistants

Parameters

Name	In	Type	Required	Description
type	query	AssistantType | null	no

Responses

• 200 — OK
• application/json → AssistantPublicResponseList
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants

create_assistant

Request body

Content-Type: application/json

Schema: CreateAssistantRequest

Responses

• 201 — Created
• application/json → AssistantResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/

create_assistant

Request body

Content-Type: application/json

Schema: CreateAssistantRequest

Responses

• 201 — Created
• application/json → AssistantResponse
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/assistants/deleted

get_deleted_assistants

Parameters

Name	In	Type	Required	Description
type	query	AssistantType | null	no

Responses

• 200 — OK
• application/json → AssistantPublicResponseList
• 422 — Unprocessable Content
• application/json → ValidationError

DELETE /api/assistants/{assistant_id}

delete_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → MessageResponse
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/assistants/{assistant_id}

get_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → AssistantResponse
• 422 — Unprocessable Content
• application/json → ValidationError

PATCH /api/assistants/{assistant_id}

patch_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: PatchAssistantRequest

Responses

• 200 — OK
• application/json → AssistantResponse
• 422 — Unprocessable Content
• application/json → ValidationError

PUT /api/assistants/{assistant_id}

update_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: UpdateAssistantRequest

Responses

• 200 — OK
• application/json → AssistantResponse
• 422 — Unprocessable Content
• application/json → ValidationError

PUT /api/assistants/{assistant_id}/approved-external-services

approve_external_services

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: ApproveExternalServicesRequest

Responses

• 200 — OK
• application/json → AssistantResponse
• 422 — Unprocessable Content
• application/json → ValidationError

PUT /api/assistants/{assistant_id}/catalog-metadata

set_assistant_catalog_metadata

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: SetCatalogMetadataRequest

Responses

• 200 — OK
• application/json → AssistantResponse
• 422 — Unprocessable Content
• application/json → ValidationError

DELETE /api/assistants/{assistant_id}/permanent

permanently_delete_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → MessageResponse
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/assistants/{assistant_id}/public

get_public_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → AssistantPublicResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/restore

restore_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → AssistantResponse
• 422 — Unprocessable Content
• application/json → ValidationError

automations

GET /api/assistants/{assistant_id}/automations

list_assistant_automations

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → AutomationResponseList
• 422 — Unprocessable Content
• application/json → ValidationError

avatar

GET /api/assistants/avatar/upload/content-types

get_allowed_avatar_content_types

Responses

• 200 — OK
• application/json → AllowedAvatarContentTypesResponse
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/assistants/avatar/upload/content-types/

get_allowed_avatar_content_types

Responses

• 200 — OK
• application/json → AllowedAvatarContentTypesResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/avatar/generate

generate_avatar

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: GenerateAssistantAvatarRequest

Responses

• 200 — OK
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/avatar/upload

upload_avatar

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: multipart/form-data

Schema: UploadAssistantAvatarForm

Responses

• 200 — OK
• 422 — Unprocessable Content
• application/json → ValidationError

content

POST /api/assistants/{assistant_id}/content

add_assistant_content

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: AddAssistantContentRequest

Responses

• 201 — Created
• application/json → AssistantMessageResponse
• 422 — Unprocessable Content
• application/json → ValidationError

data

DELETE /api/assistants/{assistant_id}/data

delete_asssitant_data

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: DeleteAssistantDataRequest

Responses

• 201 — Created
• application/json → DeleteAssistantDataResponse
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/assistants/{assistant_id}/data

query_asssitant_data

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → QueryAssistantDataResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/data

create_asssitant_data

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: CreateAssistantDataRequest

Responses

• 201 — Created
• application/json → CreateAssistantDataResponse
• 422 — Unprocessable Content
• application/json → ValidationError

PUT /api/assistants/{assistant_id}/data

bulk_update_assistant_data

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: BulkUpdateAssistantDataRequest

Responses

• 200 — OK
• application/json → UpdateAssistantDataResponse
• 422 — Unprocessable Content
• application/json → ValidationError

DELETE /api/assistants/{assistant_id}/data/{data_id}

delete_asssitant_data_path

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
data_id	path	string (uuid)	yes

Responses

• 201 — Created
• application/json → DeleteAssistantDataResponse
• 422 — Unprocessable Content
• application/json → ValidationError

PUT /api/assistants/{assistant_id}/data/{data_id}

update_asssitant_data

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
data_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: UpdateAssistantDataRequest

Responses

• 201 — Created
• application/json → UpdateAssistantDataResponse
• 422 — Unprocessable Content
• application/json → ValidationError

favourites

GET /api/assistants/favourites

get_favourite_assistants

Responses

• 200 — OK
• application/json → AssistantPublicResponseList
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/favourites/reorder

reorder_favourites

Request body

Content-Type: application/json

Schema: ReorderFavouritesRequest

Responses

• 200 — OK
• application/json → MessageResponse
• 422 — Unprocessable Content
• application/json → ValidationError

DELETE /api/assistants/{assistant_id}/favourite

remove_favourite_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → MessageResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/favourite

add_favourite_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → MessageResponse
• 422 — Unprocessable Content
• application/json → ValidationError

files

GET /api/assistants/{assistant_id}/files

get_assistant_files

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → AssistantFileList
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/files

upload_file_to_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: multipart/form-data

Schema: UploadAssistantFileForm

Responses

• 201 — Created
• application/json → AssistantFileUploadResponse
• 422 — Unprocessable Content
• application/json → ValidationError

DELETE /api/assistants/{assistant_id}/files/{file_id}

delete_file_from_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
file_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → AssistantFileMessageResponse
• 422 — Unprocessable Content
• application/json → ValidationError

PUT /api/assistants/{assistant_id}/files/{file_id}

update_file_information

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
file_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: UpdateAssistantFileRequest

Responses

• 200 — OK
• application/json → MessageResponse
• 422 — Unprocessable Content
• application/json → ValidationError

functions

GET /api/assistants/{assistant_id}/functions

get_assistant_skill_functions

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → AssistantCustomFunctionsResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/functions/{function_name}

execute_assistant_skill_function

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
function_name	path	string	yes
conversation_id	query	string (uuid) | null	no
delay	query	integer	no
file_progress_name	query	string | null	no

Request body

Content-Type: application/json

Schema: ExecuteSkillFunctionRequest

Responses

knowledge-bases

GET /api/assistants/{assistant_id}/knowledge-bases

list_assistant_knowledge_bases

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → KnowledgeBaseResponseList
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/knowledge-bases

attach_knowledge_base

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: KnowledgeBaseAttachBody

Responses

• 201 — Created
• application/json → KnowledgeBaseResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/knowledge-bases/create-and-attach

create_and_attach_knowledge_base

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: KnowledgeBaseCreateAndAttachBody

Responses

• 201 — Created
• application/json → KnowledgeBaseResponse
• 422 — Unprocessable Content
• application/json → ValidationError

DELETE /api/assistants/{assistant_id}/knowledge-bases/{knowledge_base_id}

detach_knowledge_base

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
knowledge_base_id	path	string (uuid)	yes

Responses

• 204 — No Content
• 422 — Unprocessable Content
• application/json → ValidationError

PUT /api/assistants/{assistant_id}/knowledge-bases/{knowledge_base_id}

update_assistant_knowledge_base

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
knowledge_base_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: KnowledgeBaseUpdateBody

Responses

• 200 — OK
• application/json → KnowledgeBaseResponse
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/assistants/{assistant_id}/knowledge-bases/{knowledge_base_id}/documents

list_assistant_knowledge_base_documents

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
knowledge_base_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → KnowledgeBaseDocumentResponseList
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/assistants/{assistant_id}/web-links

list_assistant_web_links

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → KnowledgeBaseDocumentResponseList
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/web-links

add_web_link_to_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: AddKnowledgeBaseLinkBody

Responses

• 201 — Created
• application/json → KnowledgeBaseLinkResponse
• 422 — Unprocessable Content
• application/json → ValidationError

DELETE /api/assistants/{assistant_id}/web-links/{document_id}

delete_web_link_from_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
document_id	path	string (uuid)	yes

Responses

• 204 — No Content
• 422 — Unprocessable Content
• application/json → ValidationError

links

GET /api/assistants/{assistant_id}/links

get_assistant_links

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → LinkResponseList
• 422 — Unprocessable Content
• application/json → ValidationError

search

POST /api/assistants/{assistant_id}/search

search_assistant_data

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: SearchAssistantDataRequest

Responses

skills

GET /api/assistants/{assistant_id}/skills

get_assistant_skills

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → SkillSummaryResponseList
• 422 — Unprocessable Content
• application/json → ValidationError

DELETE /api/assistants/{assistant_id}/skills/{skill_id}

remove_skill_from_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
skill_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → AssistantSkillResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/skills/{skill_id}

add_skill_to_assistant

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
skill_id	path	string (uuid)	yes

Responses

• 201 — Created
• application/json → AssistantSkillResponse
• 422 — Unprocessable Content
• application/json → ValidationError

token

GET /api/assistants/{assistant_id}/canvas/required-consent

canvas_required_consent

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Responses

• 200 — OK
• application/json → CanvasRequiredConsentResponseList
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/user_token

assistant_user_token

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: application/json

Schema: AssistantUserTokenRequest

Responses

• 200 — OK
• application/json → AssistantUserTokenResponse
• 422 — Unprocessable Content
• application/json → ValidationError

ui

POST /api/assistants/{assistant_id}/ui/deploy

deploy_assistant_ui

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes

Request body

Content-Type: multipart/form-data

Schema: DeployAssistantUIForm

Responses

• 200 — OK
• application/json → AssistantResponse
• 422 — Unprocessable Content
• application/json → ValidationError

GET /api/assistants/{assistant_id}/ui/{path}

get_assistant_ui

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
path	path	string (path)	yes

Responses

• 200 — OK
• application/json → AssistantUIUrlResponse
• 422 — Unprocessable Content
• application/json → ValidationError

user_data

GET /api/assistants/{assistant_id}/user_data/{key}

get_user_data

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
key	path	string	yes

Responses

• 200 — OK
• application/json → AssistantUserDataResponse
• 422 — Unprocessable Content
• application/json → ValidationError

POST /api/assistants/{assistant_id}/user_data/{key}

set_user_data

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
key	path	string	yes

Request body

Content-Type: application/json

Schema: SetAssistantUserDataRequest

Responses

• 201 — Created
• application/json → AssistantUserDataMessageResponse
• 422 — Unprocessable Content
• application/json → ValidationError

webhooks

POST /api/assistants/{assistant_id}/webhooks/{webhook_path}

webhook

Parameters

Name	In	Type	Required	Description
assistant_id	path	string (uuid)	yes
webhook_path	path	string	yes

Responses

• 200 — OK
• application/json → WebhookResponse
• 422 — Unprocessable Content
• application/json → ValidationError