Scroll down for example requests and responses.
Base URLs:
Authentication HTTP Authentication, scheme: Bearer HTTP Bearer authentication Default ListUsers GET /users
Example responses
200 Response {
"properties" : {
"users" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organizations" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"user_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"email" ,
"organizations" ,
"updated_at" ,
"user_id"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ApiKeys DeleteApiKey DELETE /api-keys/{api_key_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetApiKey GET /api-keys/{api_key_id}
Parameters Example responses
200 Response {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateApiKey PATCH /api-keys/{api_key_id}
Body parameter
{
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListOrganizationApiKeys GET /organizations/{organization_id}/api-keys
Parameters Example responses
200 Response {
"properties" : {
"api_keys" : {
"items" : {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"api_keys" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateOrganizationApiKey POST /organizations/{organization_id}/api-keys
Body parameter
{
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at" ,
"value"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListApiKeys GET /users/{user_id}/api-keys
Parameters Example responses
200 Response {
"properties" : {
"api_keys" : {
"items" : {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"api_keys" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateApiKey POST /users/{user_id}/api-keys
Body parameter
{
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at" ,
"value"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
AssistantRuns GetAssistantRun GET /assistant-runs/{assistant_run_id}
Parameters Example responses
200 Response {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"output" : { } ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"assistant_id" ,
"assistant_run_id" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"knowledge_base_ids" ,
"retriever_ids" ,
"ruleset_ids" ,
"status" ,
"stream" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CancelAssistantRun POST /assistant-runs/{assistant_run_id}/cancel
Parameters Example responses
200 Response {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"output" : { } ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"assistant_id" ,
"assistant_run_id" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"knowledge_base_ids" ,
"retriever_ids" ,
"ruleset_ids" ,
"status" ,
"stream" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListAssistantRuns GET /assistants/{assistant_id}/runs
Parameters Enumerated Values Example responses
200 Response {
"properties" : {
"assistant_runs" : {
"items" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"output" : { } ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"assistant_id" ,
"assistant_run_id" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"knowledge_base_ids" ,
"retriever_ids" ,
"ruleset_ids" ,
"status" ,
"stream" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"assistant_runs" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateAssistantRun POST /assistants/{assistant_id}/runs
Body parameter
{
"properties" : {
"additional_knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"additional_retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"additional_ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"additional_structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"additional_tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"new_thread" : {
"description" : "If true, create a new thread for this run to be returned in the response thread_id." ,
"type" : "boolean"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"description" : "If provided, the run will be associated with the given thread. This takes precedence over new_thread." ,
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"output" : { } ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"assistant_id" ,
"assistant_run_id" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"knowledge_base_ids" ,
"retriever_ids" ,
"ruleset_ids" ,
"status" ,
"stream" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Events ListAssistantEvents GET /assistant-runs/{assistant_run_id}/events
Parameters Example responses
200 Response {
"properties" : {
"count" : {
"type" : "number"
} ,
"events" : {
"items" : {
"properties" : {
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"event_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"origin" : {
"type" : "string"
} ,
"payload" : { } ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"assistant_run_id" ,
"created_at" ,
"event_id" ,
"origin" ,
"payload" ,
"timestamp" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"limit" : {
"type" : "number"
} ,
"next_offset" : {
"type" : "number"
} ,
"offset" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
}
} ,
"required" : [
"count" ,
"events" ,
"limit" ,
"next_offset" ,
"offset" ,
"total_count"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetAssistantRunEventsSSE GET /assistant-runs/{assistant_run_id}/events/stream
Parameters Example responses
200 Response 400 Response
{
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetEvent GET /events/{event_id}
Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"event_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"origin" : {
"type" : "string"
} ,
"payload" : { } ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"event_id" ,
"origin" ,
"payload" ,
"structure_run_id" ,
"timestamp" ,
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListEvents GET /structure-runs/{structure_run_id}/events
Parameters Example responses
200 Response {
"properties" : {
"count" : {
"type" : "number"
} ,
"events" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"event_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"origin" : {
"type" : "string"
} ,
"payload" : { } ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"event_id" ,
"origin" ,
"payload" ,
"structure_run_id" ,
"timestamp" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"limit" : {
"type" : "number"
} ,
"next_offset" : {
"type" : "number"
} ,
"offset" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
}
} ,
"required" : [
"count" ,
"events" ,
"limit" ,
"next_offset" ,
"offset" ,
"total_count"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateEvents POST /structure-runs/{structure_run_id}/events
Body parameter
{
"properties" : {
"events" : {
"items" : {
"properties" : {
"payload" : { } ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"timestamp" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetStructureRunEventsSSE GET /structure-runs/{structure_run_id}/events/stream
Parameters Example responses
200 Response 400 Response
{
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Assistants ListAssistants GET /assistants
Parameters Example responses
200 Response {
"properties" : {
"assistants" : {
"items" : {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"description" ,
"knowledge_base_ids" ,
"name" ,
"organization_id" ,
"retriever_ids" ,
"ruleset_ids" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"assistants" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateAssistant POST /assistants
Body parameter
{
"properties" : {
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"description" ,
"knowledge_base_ids" ,
"name" ,
"organization_id" ,
"retriever_ids" ,
"ruleset_ids" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteAssistant DELETE /assistants/{assistant_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetAssistant GET /assistants/{assistant_id}
Parameters Example responses
200 Response {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"description" ,
"knowledge_base_ids" ,
"name" ,
"organization_id" ,
"retriever_ids" ,
"ruleset_ids" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateAssistant PATCH /assistants/{assistant_id}
Body parameter
{
"properties" : {
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"description" ,
"knowledge_base_ids" ,
"name" ,
"organization_id" ,
"retriever_ids" ,
"ruleset_ids" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Billing CreateCheckoutSession POST /billing/checkout-session
Body parameter
{
"properties" : {
"price_lookup_key" : {
"type" : "string"
}
} ,
"required" : [
"price_lookup_key"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"redirect_url" : {
"type" : "string"
}
} ,
"required" : [
"redirect_url"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateBillingManagementUrl POST /billing/management-url
Example responses
201 Response {
"properties" : {
"billing_management_url" : {
"type" : "string"
}
} ,
"required" : [
"billing_management_url"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Buckets ListBuckets GET /buckets
Parameters Example responses
200 Response {
"properties" : {
"buckets" : {
"items" : {
"properties" : {
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bucket_id" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"buckets" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateBucket POST /buckets
Body parameter
{
"properties" : {
"name" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bucket_id" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteBucket DELETE /buckets/{bucket_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetBucket GET /buckets/{bucket_id}
Parameters Example responses
200 Response {
"properties" : {
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bucket_id" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateBucket PATCH /buckets/{bucket_id}
Body parameter
{
"properties" : {
"name" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bucket_id" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Assets CreateAssetUrl POST /buckets/{bucket_id}/asset-urls/{name}
Body parameter
{
"properties" : {
"operation" : {
"enum" : [
"PUT" ,
"GET"
] ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"headers" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"url" : {
"type" : "string"
}
} ,
"required" : [
"headers" ,
"url"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListAssets GET /buckets/{bucket_id}/assets
Parameters Example responses
200 Response {
"properties" : {
"assets" : {
"items" : {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"contents" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"size" : {
"type" : "number"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"postfix" : {
"type" : "string"
} ,
"prefix" : {
"type" : "string"
}
} ,
"required" : [
"assets" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateAsset PUT /buckets/{bucket_id}/assets
Body parameter
{
"properties" : {
"name" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"contents" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"size" : {
"type" : "number"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteAsset DELETE /buckets/{bucket_id}/assets/{name}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetAsset GET /buckets/{bucket_id}/assets/{name}
Parameters Example responses
200 Response {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"contents" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"size" : {
"type" : "number"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Chat Messages CreateChatMessage POST /chat/messages
Body parameter
{
"properties" : {
"driver_configuration" : {
"properties" : {
"extra_params" : { } ,
"max_tokens" : {
"type" : "number"
} ,
"model" : {
"type" : "string"
} ,
"structured_output_strategy" : {
"type" : "string"
} ,
"temperature" : {
"format" : "float" ,
"type" : "number"
} ,
"use_native_tools" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
"messages" : {
"items" : {
"properties" : {
"content" : {
"items" : {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"role" : {
"type" : "string"
} ,
"usage" : {
"properties" : {
"input_tokens" : {
"type" : "number"
} ,
"output_tokens" : {
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"input_tokens" ,
"output_tokens" ,
"type"
] ,
"type" : "object"
}
} ,
"required" : [
"content" ,
"role" ,
"usage"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output_schema" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} ,
"tools" : {
"items" : {
"properties" : {
"activities" : {
"items" : {
"properties" : {
"description" : {
"type" : "string"
} ,
"json_schema" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"description" ,
"json_schema" ,
"name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"activities" ,
"name"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"driver_configuration" ,
"messages" ,
"output_schema" ,
"tools"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"content" : {
"items" : {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"role" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"usage" : {
"properties" : {
"input_tokens" : {
"type" : "number"
} ,
"output_tokens" : {
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"input_tokens" ,
"output_tokens" ,
"type"
] ,
"type" : "object"
}
} ,
"required" : [
"content" ,
"role" ,
"type" ,
"usage"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateChatMessageStream POST /chat/messages/stream
Body parameter
{
"properties" : {
"driver_configuration" : {
"properties" : {
"extra_params" : { } ,
"max_tokens" : {
"type" : "number"
} ,
"model" : {
"type" : "string"
} ,
"structured_output_strategy" : {
"type" : "string"
} ,
"temperature" : {
"format" : "float" ,
"type" : "number"
} ,
"use_native_tools" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
"messages" : {
"items" : {
"properties" : {
"content" : {
"items" : {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"role" : {
"type" : "string"
} ,
"usage" : {
"properties" : {
"input_tokens" : {
"type" : "number"
} ,
"output_tokens" : {
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"input_tokens" ,
"output_tokens" ,
"type"
] ,
"type" : "object"
}
} ,
"required" : [
"content" ,
"role" ,
"usage"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output_schema" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} ,
"tools" : {
"items" : {
"properties" : {
"activities" : {
"items" : {
"properties" : {
"description" : {
"type" : "string"
} ,
"json_schema" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"description" ,
"json_schema" ,
"name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"activities" ,
"name"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"driver_configuration" ,
"messages" ,
"output_schema" ,
"tools"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"content" : {
"items" : {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"role" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"usage" : {
"properties" : {
"input_tokens" : {
"type" : "number"
} ,
"output_tokens" : {
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"input_tokens" ,
"output_tokens" ,
"type"
] ,
"type" : "object"
}
} ,
"required" : [
"content" ,
"role" ,
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Configs GetConfig GET /config
Example responses
200 Response {
"properties" : {
"data_lake_s3_bucket" : {
"type" : "string"
} ,
"data_lake_s3_region" : {
"type" : "string"
} ,
"data_lake_s3_url" : {
"type" : "string"
} ,
"google_drive_data_connector_client_id" : {
"type" : "string"
}
} ,
"required" : [
"data_lake_s3_bucket" ,
"data_lake_s3_region" ,
"data_lake_s3_url" ,
"google_drive_data_connector_client_id"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Connections ListConnections GET /connections
Parameters Example responses
200 Response {
"properties" : {
"connections" : {
"items" : {
"properties" : {
"connection_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"connection_id" ,
"created_at" ,
"created_by" ,
"name" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateConnection POST /connections
Body parameter
{
"properties" : {
"credentials" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"auth_code" : {
"type" : "string"
}
} ,
"required" : [
"auth_code"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
}
]
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"credentials" ,
"type"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"connection_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"connection_id" ,
"created_at" ,
"created_by" ,
"name" ,
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteConnection DELETE /connections/{connection_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetToken GET /connections/{connection_id}/access-token
Parameters Example responses
200 Response {
"properties" : {
"access_token" : {
"type" : "string"
}
} ,
"required" : [
"access_token"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Structures GetStructuresDashboard GET /dashboards/structures
Parameters Enumerated Values Example responses
200 Response {
"properties" : {
"deployment_count_gauge" : {
"properties" : {
"active_count" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"deployment_duration_gauge" : {
"properties" : {
"total_seconds" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"deployment_error_rate_gauge" : {
"properties" : {
"rate" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} ,
"duration_plot" : {
"properties" : {
"seconds_avg" : {
"type" : "number"
} ,
"seconds_p100" : {
"type" : "number"
} ,
"seconds_p50" : {
"type" : "number"
} ,
"timeseries" : {
"items" : {
"properties" : {
"seconds_p0" : {
"type" : "number"
} ,
"seconds_p100" : {
"type" : "number"
} ,
"seconds_p50" : {
"type" : "number"
} ,
"time" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} ,
"error_rate_gauge" : {
"properties" : {
"error_type_counts" : {
"items" : {
"properties" : {
"count" : {
"type" : "number"
} ,
"error_type" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"rate" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} ,
"run_count_gauge" : {
"properties" : {
"active_count" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"run_duration_gauge" : {
"properties" : {
"activity_durations" : {
"items" : {
"properties" : {
"activity_type" : {
"type" : "string"
} ,
"seconds" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"total_seconds" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"token_count_gauge" : {
"properties" : {
"by_model" : {
"additionalProperties" : {
"properties" : {
"input" : {
"format" : "float" ,
"type" : "number"
} ,
"output" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} ,
"type" : "object"
} ,
"input" : {
"format" : "float" ,
"type" : "number"
} ,
"output" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
}
} ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListStructures GET /structures
Parameters Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"structures" : {
"items" : {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"structures"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateStructure POST /structures
Body parameter
{
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"structure_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteStructure DELETE /structures/{structure_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetStructure GET /structures/{structure_id}
Parameters Example responses
200 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateStructure PATCH /structures/{structure_id}
Body parameter
{
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"structure_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
InvokeStructureWebhookGet GET /structures/{structure_id}/webhook
Invoke a webhook for a structure. Must have the webhook_enabled flag set to true.
Parameters Example responses
200 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
InvokeStructureWebhookPost POST /structures/{structure_id}/webhook
Invoke a webhook for a structure, sending the POST body as the first Structure arg. Must have the webhook_enabled flag set to true.
Parameters Example responses
200 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DataConnectors ListDataConnectors GET /data-connectors
Parameters Example responses
200 Response {
"properties" : {
"data_connectors" : {
"items" : {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"data_connector_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"data_connectors" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateDataConnector POST /data-connectors
Body parameter
{
"properties" : {
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_api_token" : {
"type" : "string"
} ,
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_api_token" ,
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"auth_code" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"auth_code" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"aws_secret_access_key" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"aws_secret_access_key" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"name" ,
"type"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"schedule_expression" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"data_connector_id" ,
"name" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteDataConnector DELETE /data-connectors/{data_connector_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetDataConnector GET /data-connectors/{data_connector_id}
Parameters Example responses
200 Response {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"data_connector_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateDataConnector PATCH /data-connectors/{data_connector_id}
Body parameter
{
"properties" : {
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_api_token" : {
"type" : "string"
} ,
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_api_token" ,
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"auth_code" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"auth_code" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"aws_secret_access_key" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"aws_secret_access_key" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"data_connector_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DataJobs ListDataJobs GET /data-connectors/{data_connector_id}/data-jobs
Parameters Enumerated Values Example responses
200 Response {
"properties" : {
"data_jobs" : {
"items" : {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"data_connector_id" ,
"data_job_id" ,
"status"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"data_jobs" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateDataJob POST /data-connectors/{data_connector_id}/data-jobs
Parameters Example responses
202 Response {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"data_connector_id" ,
"data_job_id" ,
"status"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetDataJob GET /data-jobs/{data_job_id}
Parameters Example responses
200 Response {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"data_connector_id" ,
"data_job_id" ,
"status"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CancelDataJob POST /data-jobs/{data_job_id}/cancel
Parameters Example responses
200 Response {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"data_connector_id" ,
"data_job_id" ,
"status"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Deployments GetDeployment GET /deployments/{deployment_id}
Parameters Example responses
200 Response {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListFunctionDeployments GET /functions/{function_id}/deployments
Parameters Example responses
200 Response {
"properties" : {
"deployments" : {
"items" : {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"function_id" ,
"status"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"deployments" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateFunctionDeployment POST /functions/{function_id}/deployments
Body parameter
{
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"access_token" : {
"maxLength" : 1000 ,
"minLength" : 1 ,
"type" : "string"
} ,
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
}
]
} ,
"force" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Parameters Example responses
202 Response {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"function_id" ,
"status"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListStructureDeployments GET /structures/{structure_id}/deployments
Parameters Enumerated Values Example responses
200 Response {
"properties" : {
"deployments" : {
"items" : {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status" ,
"structure_id"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"deployments" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateStructureDeployment POST /structures/{structure_id}/deployments
Body parameter
{
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"access_token" : {
"maxLength" : 1000 ,
"minLength" : 1 ,
"type" : "string"
} ,
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
}
]
} ,
"force" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Parameters Example responses
202 Response {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status" ,
"structure_id"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GET /tools/{tool_id}/deployments
Parameters Example responses
200 Response {
"properties" : {
"deployments" : {
"items" : {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status" ,
"tool_id"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"deployments" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
POST /tools/{tool_id}/deployments
Body parameter
{
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"access_token" : {
"maxLength" : 1000 ,
"minLength" : 1 ,
"type" : "string"
} ,
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
}
]
} ,
"force" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Parameters Example responses
202 Response {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status" ,
"tool_id"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
FunctionRuns GetFunctionRun GET /function-runs/{function_run_id}
Parameters Example responses
200 Response {
"properties" : {
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"input" : { } ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"runtime_path" : {
"type" : "string"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"completed_at" ,
"created_at" ,
"created_by" ,
"function_id" ,
"function_run_id" ,
"input" ,
"runtime_path" ,
"started_at" ,
"status" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListFunctionRunLogs GET /function-runs/{function_run_id}/logs
Parameters Example responses
200 Response {
"properties" : {
"logs" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"logs"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListFunctionRuns GET /functions/{function_id}/runs
Parameters Enumerated Values Example responses
200 Response {
"properties" : {
"function_runs" : {
"items" : {
"properties" : {
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"input" : { } ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"runtime_path" : {
"type" : "string"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"completed_at" ,
"created_at" ,
"created_by" ,
"function_id" ,
"function_run_id" ,
"input" ,
"runtime_path" ,
"started_at" ,
"status" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"function_runs" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Functions ListFunctions GET /functions
Parameters Example responses
200 Response {
"properties" : {
"functions" : {
"items" : {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"function_id" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"functions" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateFunction POST /functions
Body parameter
{
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"function_id" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteFunction DELETE /functions/{function_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetFunction GET /functions/{function_id}
Parameters Example responses
200 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"function_id" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateFunction PATCH /functions/{function_id}
Body parameter
{
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"function_id" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
FunctionExecute CreateFunctionExecutionGet GET /functions/{function_id}/execute
Executes the function with the given input. Query parameters are passed as 'query_params' to the function.
Parameters Example responses
200 Response Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateFunctionExecutionPost POST /functions/{function_id}/execute
Executes the function with the given input. Input body is passed as 'body' to the function. Query parameters are passed as 'query_params'.
Body parameter
Parameters Example responses
200 Response Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Integrations ListIntegrations GET /integrations
Parameters Example responses
200 Response {
"properties" : {
"integrations" : {
"items" : {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"integration_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_ids" ,
"config" ,
"created_at" ,
"created_by" ,
"description" ,
"integration_id" ,
"name" ,
"organization_id" ,
"structure_ids" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"integrations" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateIntegration POST /integrations
Body parameter
{
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_name"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"name" ,
"type"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"integration_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_ids" ,
"config" ,
"created_at" ,
"created_by" ,
"description" ,
"integration_id" ,
"name" ,
"organization_id" ,
"structure_ids" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteIntegration DELETE /integrations/{integration_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetIntegration GET /integrations/{integration_id}
Parameters Example responses
200 Response {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"integration_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_ids" ,
"config" ,
"created_at" ,
"created_by" ,
"description" ,
"integration_id" ,
"name" ,
"organization_id" ,
"structure_ids" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateIntegration PATCH /integrations/{integration_id}
Body parameter
{
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_name"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"integration_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_ids" ,
"config" ,
"created_at" ,
"created_by" ,
"description" ,
"integration_id" ,
"name" ,
"organization_id" ,
"structure_ids" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Invites ListUserInvites GET /invites
Parameters Example responses
200 Response {
"properties" : {
"invites" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"expires_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"invite_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"responded_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"ACCEPTED" ,
"EXPIRED" ,
"PENDING" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"email" ,
"expires_at" ,
"invite_id" ,
"organization_id" ,
"status"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"invites" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteInvite DELETE /invites/{invite_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetInvite GET /invites/{invite_id}
Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"expires_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"invite_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"responded_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"ACCEPTED" ,
"EXPIRED" ,
"PENDING" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"email" ,
"expires_at" ,
"invite_id" ,
"organization_id" ,
"status"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
RespondToInvite POST /invites/{invite_id}/response
Body parameter
{
"properties" : {
"response" : {
"enum" : [
"ACCEPTED" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"response"
] ,
"type" : "object"
} Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListInvites GET /organizations/{organization_id}/invites
Parameters Example responses
200 Response {
"properties" : {
"invites" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"expires_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"invite_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"responded_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"ACCEPTED" ,
"EXPIRED" ,
"PENDING" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"email" ,
"expires_at" ,
"invite_id" ,
"organization_id" ,
"status"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"invites" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateInvite POST /organizations/{organization_id}/invites
Body parameter
{
"properties" : {
"email" : {
"maxLength" : 254 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"email"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"expires_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"invite_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"responded_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"ACCEPTED" ,
"EXPIRED" ,
"PENDING" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"email" ,
"expires_at" ,
"invite_id" ,
"organization_id" ,
"status"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
KnowledgeBaseJobs GetKnowledgeBaseJob GET /knowledge-base-jobs/{knowledge_base_job_id}
Parameters Example responses
200 Response {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_job_id" ,
"status"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CancelKnowledgeBaseJob POST /knowledge-base-jobs/{knowledge_base_job_id}/cancel
Parameters Example responses
200 Response {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_job_id" ,
"status"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListKnowledgeBaseJobs GET /knowledge-bases/{knowledge_base_id}/knowledge-base-jobs
Parameters Enumerated Values Example responses
200 Response {
"properties" : {
"knowledge_base_jobs" : {
"items" : {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_job_id" ,
"status"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"knowledge_base_jobs" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateKnowledgeBaseJob POST /knowledge-bases/{knowledge_base_id}/knowledge-base-jobs
Parameters Example responses
202 Response {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_job_id" ,
"status"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
KnowledgeBases GetKnowledgeBaseQuery GET /knowledge-base-queries/{knowledge_base_query_id}
Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"entries" : {
"items" : {
"properties" : {
"id" : {
"type" : "string"
} ,
"meta" : {
"additionalProperties" : {
"type" : "string"
} ,
"type" : "object"
} ,
"namespace" : {
"type" : "string"
} ,
"score" : {
"format" : "float" ,
"type" : "number"
} ,
"vector" : {
"items" : {
"format" : "float" ,
"type" : "number"
} ,
"type" : "array"
}
} ,
"required" : [
"id" ,
"score"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_query_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"entries" ,
"knowledge_base_id" ,
"knowledge_base_query_id" ,
"query"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetKnowledgeBaseSearch GET /knowledge-base-searches/{knowledge_base_search_id}
Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_search_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
} ,
"result" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_search_id" ,
"query" ,
"result"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListKnowledgeBases GET /knowledge-bases
Parameters Example responses
200 Response {
"properties" : {
"knowledge_bases" : {
"items" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"asset_paths" ,
"config" ,
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"knowledge_bases" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateKnowledgeBase POST /knowledge-bases
Body parameter
{
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"password"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"structured_columns" ,
"unstructured_columns"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"config" ,
"name" ,
"type"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"asset_paths" ,
"config" ,
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteKnowledgeBase DELETE /knowledge-bases/{knowledge_base_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetKnowledgeBase GET /knowledge-bases/{knowledge_base_id}
Parameters Example responses
200 Response {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"asset_paths" ,
"config" ,
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateKnowledgeBase PATCH /knowledge-bases/{knowledge_base_id}
Body parameter
{
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"password"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"structured_columns" ,
"unstructured_columns"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"config" ,
"type"
] ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"asset_paths" ,
"config" ,
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListKnowledgeBaseQueries GET /knowledge-bases/{knowledge_base_id}/queries
Parameters Example responses
200 Response {
"properties" : {
"knowledge_base_queries" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"entries" : {
"items" : {
"properties" : {
"id" : {
"type" : "string"
} ,
"meta" : {
"additionalProperties" : {
"type" : "string"
} ,
"type" : "object"
} ,
"namespace" : {
"type" : "string"
} ,
"score" : {
"format" : "float" ,
"type" : "number"
} ,
"vector" : {
"items" : {
"format" : "float" ,
"type" : "number"
} ,
"type" : "array"
}
} ,
"required" : [
"id" ,
"score"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_query_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"entries" ,
"knowledge_base_id" ,
"knowledge_base_query_id" ,
"query"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
QueryKnowledgeBase POST /knowledge-bases/{knowledge_base_id}/query
Body parameter
{
"properties" : {
"query" : {
"type" : "string"
} ,
"query_args" : { }
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"entries" : {
"items" : {
"properties" : {
"id" : {
"type" : "string"
} ,
"meta" : {
"additionalProperties" : {
"type" : "string"
} ,
"type" : "object"
} ,
"namespace" : {
"type" : "string"
} ,
"score" : {
"format" : "float" ,
"type" : "number"
} ,
"vector" : {
"items" : {
"format" : "float" ,
"type" : "number"
} ,
"type" : "array"
}
} ,
"required" : [
"id" ,
"score"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_query_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"entries" ,
"knowledge_base_id" ,
"knowledge_base_query_id" ,
"query"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
SearchKnowledgeBase POST /knowledge-bases/{knowledge_base_id}/search
Body parameter
{
"properties" : {
"query" : {
"type" : "string"
} ,
"query_args" : { }
} ,
"required" : [
"query"
] ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_search_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
} ,
"result" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_search_id" ,
"query" ,
"result"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListKnowledgeBaseSearches GET /knowledge-bases/{knowledge_base_id}/searches
Parameters Example responses
200 Response {
"properties" : {
"knowledge_base_searches" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_search_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
} ,
"result" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_search_id" ,
"query" ,
"result"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Libraries ListLibraries GET /libraries
Parameters Example responses
200 Response {
"properties" : {
"libraries" : {
"items" : {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"library_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"data_connector_ids" ,
"knowledge_base_ids" ,
"library_id" ,
"name" ,
"organization_id" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"libraries" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateLibrary POST /libraries
Body parameter
{
"properties" : {
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"knowledge_base_configs" : {
"items" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"password"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"structured_columns" ,
"unstructured_columns"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"data_connector_ids" ,
"knowledge_base_configs" ,
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"library_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"data_connector_ids" ,
"knowledge_base_ids" ,
"library_id" ,
"name" ,
"organization_id" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteLibrary DELETE /libraries/{library_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetLibrary GET /libraries/{library_id}
Parameters Example responses
200 Response {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"library_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"data_connector_ids" ,
"knowledge_base_ids" ,
"library_id" ,
"name" ,
"organization_id" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateLibrary PATCH /libraries/{library_id}
Body parameter
{
"properties" : {
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"knowledge_base_configs" : {
"items" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"password"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"structured_columns" ,
"unstructured_columns"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"data_connector_ids" ,
"knowledge_base_configs" ,
"name"
] ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"library_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"data_connector_ids" ,
"knowledge_base_ids" ,
"library_id" ,
"name" ,
"organization_id" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Messages DeleteMessage DELETE /messages/{message_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetMessage GET /messages/{message_id}
Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"index" : {
"type" : "number"
} ,
"input" : {
"type" : "string"
} ,
"message_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"index" ,
"input" ,
"message_id" ,
"metadata" ,
"output" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateMessage PATCH /messages/{message_id}
Body parameter
{
"properties" : {
"input" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"index" : {
"type" : "number"
} ,
"input" : {
"type" : "string"
} ,
"message_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"index" ,
"input" ,
"message_id" ,
"metadata" ,
"output" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListMessages GET /threads/{thread_id}/messages
Parameters Example responses
200 Response {
"properties" : {
"messages" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"index" : {
"type" : "number"
} ,
"input" : {
"type" : "string"
} ,
"message_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"index" ,
"input" ,
"message_id" ,
"metadata" ,
"output" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"messages" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateMessage POST /threads/{thread_id}/messages
Body parameter
{
"properties" : {
"input" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
}
} ,
"required" : [
"input" ,
"output"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"index" : {
"type" : "number"
} ,
"input" : {
"type" : "string"
} ,
"message_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"index" ,
"input" ,
"message_id" ,
"metadata" ,
"output" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Models ListModels GET /models
Parameters Example responses
200 Response {
"properties" : {
"models" : {
"items" : {
"properties" : {
"default" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"model_name" : {
"type" : "string"
} ,
"model_type" : {
"enum" : [
"chat" ,
"embedding" ,
"rerank" ,
"image_generation" ,
"unknown"
] ,
"type" : "string"
}
} ,
"required" : [
"default" ,
"model_name" ,
"model_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"models" ,
"pagination"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Organizations ListOrganizations GET /organizations
Example responses
200 Response {
"properties" : {
"organizations" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"default_bucket_id" : {
"type" : "string"
} ,
"description" : {
"maxLength" : 2000 ,
"type" : "string"
} ,
"entitlement" : {
"allOf" : [
{
"enum" : [
"FREE" ,
"PAID" ,
"PARTNER" ,
"UNPAID" ,
"EXPIRED"
] ,
"type" : "string"
} ,
{
"default" : "FREE"
}
]
} ,
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"default_bucket_id" ,
"description" ,
"entitlement" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateOrganization POST /organizations
Body parameter
{
"properties" : {
"description" : {
"maxLength" : 2000 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"default_bucket_id" : {
"type" : "string"
} ,
"description" : {
"maxLength" : 2000 ,
"type" : "string"
} ,
"entitlement" : {
"allOf" : [
{
"enum" : [
"FREE" ,
"PAID" ,
"PARTNER" ,
"UNPAID" ,
"EXPIRED"
] ,
"type" : "string"
} ,
{
"default" : "FREE"
}
]
} ,
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"default_bucket_id" ,
"description" ,
"entitlement" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteOrganization DELETE /organizations/{organization_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetOrganization GET /organizations/{organization_id}
Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"default_bucket_id" : {
"type" : "string"
} ,
"description" : {
"maxLength" : 2000 ,
"type" : "string"
} ,
"entitlement" : {
"allOf" : [
{
"enum" : [
"FREE" ,
"PAID" ,
"PARTNER" ,
"UNPAID" ,
"EXPIRED"
] ,
"type" : "string"
} ,
{
"default" : "FREE"
}
]
} ,
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"default_bucket_id" ,
"description" ,
"entitlement" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateOrganization PATCH /organizations/{organization_id}
Body parameter
{
"properties" : {
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"default_bucket_id" : {
"type" : "string"
} ,
"description" : {
"maxLength" : 2000 ,
"type" : "string"
} ,
"entitlement" : {
"allOf" : [
{
"enum" : [
"FREE" ,
"PAID" ,
"PARTNER" ,
"UNPAID" ,
"EXPIRED"
] ,
"type" : "string"
} ,
{
"default" : "FREE"
}
]
} ,
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"default_bucket_id" ,
"description" ,
"entitlement" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListOrganizationUsers GET /organizations/{organization_id}/users
Parameters Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"users" : {
"items" : {
"properties" : {
"email" : {
"type" : "string"
} ,
"user_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"email" ,
"user_id"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"users"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteOrganizationUser DELETE /organizations/{organization_id}/users/{user_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
RetrieverComponents ListRetrieverComponents GET /retriever-components
Parameters Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"retriever_components"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateRetrieverComponent POST /retriever-components
Body parameter
{
"properties" : {
"config" : { } ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"config" ,
"name" ,
"type"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteRetrieverComponent DELETE /retriever-components/{retriever_component_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetRetrieverComponent GET /retriever-components/{retriever_component_id}
Parameters Example responses
200 Response {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateRetrieverComponent PATCH /retriever-components/{retriever_component_id}
Body parameter
{
"properties" : {
"config" : { } ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"config" ,
"type"
] ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Retrievers ListRetrievers GET /retrievers
Parameters Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"retrievers" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"retriever_components_schema" : { } ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_components" ,
"retriever_components_schema" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"retrievers"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateRetriever POST /retrievers
Body parameter
{
"properties" : {
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"retriever_component_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"retriever_components_schema" : { } ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_components" ,
"retriever_components_schema" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteRetriever DELETE /retrievers/{retriever_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetRetriever GET /retrievers/{retriever_id}
Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"retriever_components_schema" : { } ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_components" ,
"retriever_components_schema" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateRetriever PATCH /retrievers/{retriever_id}
Body parameter
{
"properties" : {
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"retriever_component_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"retriever_components_schema" : { } ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_components" ,
"retriever_components_schema" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
QueryRetriever POST /retrievers/{retriever_id}/query
Body parameter
{
"properties" : {
"query" : {
"type" : "string"
} ,
"retriever_components_query_args" : { }
} ,
"required" : [
"query"
] ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"outputs" : {
"items" : { } ,
"type" : "array"
}
} ,
"required" : [
"outputs"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Rules ListRules GET /rules
Parameters Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"rules" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule" : {
"type" : "string"
} ,
"rule_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule" ,
"rule_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"rules"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateRule POST /rules
Body parameter
{
"properties" : {
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"rule" : {
"maxLength" : 2000 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name" ,
"rule"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule" : {
"type" : "string"
} ,
"rule_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule" ,
"rule_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteRule DELETE /rules/{rule_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetRule GET /rules/{rule_id}
Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule" : {
"type" : "string"
} ,
"rule_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule" ,
"rule_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateRule PATCH /rules/{rule_id}
Body parameter
{
"properties" : {
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"rule" : {
"maxLength" : 2000 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule" : {
"type" : "string"
} ,
"rule_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule" ,
"rule_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Rulesets ListRulesets GET /rulesets
Parameters Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"rulesets" : {
"items" : {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"description" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule_ids" ,
"ruleset_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"rulesets"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateRuleset POST /rulesets
Body parameter
{
"properties" : {
"alias" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"description" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule_ids" ,
"ruleset_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteRuleset DELETE /rulesets/{ruleset_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetRuleset GET /rulesets/{ruleset_id}
Parameters Example responses
200 Response {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"description" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule_ids" ,
"ruleset_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateRuleset PATCH /rulesets/{ruleset_id}
Body parameter
{
"properties" : {
"alias" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"description" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule_ids" ,
"ruleset_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Secrets ListSecrets GET /secrets
Parameters Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"secrets" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"secret_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"last_used" ,
"name" ,
"organization_id" ,
"secret_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"secrets"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateSecret POST /secrets
Body parameter
{
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"value" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"secret_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"last_used" ,
"name" ,
"organization_id" ,
"secret_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteSecret DELETE /secrets/{secret_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetSecret GET /secrets/{secret_id}
Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"secret_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"last_used" ,
"name" ,
"organization_id" ,
"secret_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateSecret PATCH /secrets/{secret_id}
Body parameter
{
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"value" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"secret_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"last_used" ,
"name" ,
"organization_id" ,
"secret_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
StructureRuns GetStructureRun GET /structure-runs/{structure_run_id}
Parameters Example responses
200 Response {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"started_at" ,
"status" ,
"structure_id" ,
"structure_run_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CancelStructureRun POST /structure-runs/{structure_run_id}/cancel
Parameters Example responses
200 Response {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"started_at" ,
"status" ,
"structure_id" ,
"structure_run_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListStructureRunLogs GET /structure-runs/{structure_run_id}/logs
Parameters Example responses
200 Response {
"properties" : {
"logs" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"logs"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
ListStructureRuns GET /structures/{structure_id}/runs
Parameters Enumerated Values Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"structure_runs" : {
"items" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"started_at" ,
"status" ,
"structure_id" ,
"structure_run_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"structure_runs"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateStructureRun POST /structures/{structure_id}/runs
Body parameter
{
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"args"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"started_at" ,
"status" ,
"structure_id" ,
"structure_run_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Spans ListSpans GET /structure-runs/{structure_run_id}/spans
Parameters Example responses
200 Response {
"properties" : {
"page" : {
"type" : "number"
} ,
"spans" : {
"items" : {
"properties" : {
"attributes" : { } ,
"end_time" : {
"format" : "date-time" ,
"type" : "string"
} ,
"events" : {
"properties" : {
"attributes" : { } ,
"name" : {
"type" : "string"
} ,
"timestamp" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"attributes" ,
"name" ,
"timestamp"
] ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"parent_id" : {
"type" : "string"
} ,
"span_id" : {
"type" : "string"
} ,
"start_time" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"UNSET" ,
"OK" ,
"ERROR"
] ,
"type" : "string"
} ,
"trace_id" : {
"type" : "string"
}
} ,
"required" : [
"attributes" ,
"end_time" ,
"events" ,
"name" ,
"span_id" ,
"start_time" ,
"status" ,
"trace_id"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"spans"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Threads ListThreads GET /threads
Parameters Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"threads" : {
"items" : {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"threads"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
CreateThread POST /threads
Body parameter
{
"properties" : {
"alias" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"messages" : {
"items" : {
"properties" : {
"input" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
}
} ,
"required" : [
"input" ,
"output"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DeleteThread DELETE /threads/{thread_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GetThread GET /threads/{thread_id}
Parameters Example responses
200 Response {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
UpdateThread PATCH /threads/{thread_id}
Body parameter
{
"properties" : {
"alias" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"messages" : {
"items" : {
"properties" : {
"input" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
}
} ,
"required" : [
"input" ,
"output"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GET /tool-runs/{tool_run_id}
Parameters Example responses
200 Response {
"properties" : {
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"input" : { } ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"runtime_path" : {
"type" : "string"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"completed_at" ,
"created_at" ,
"created_by" ,
"input" ,
"runtime_path" ,
"started_at" ,
"status" ,
"tool_id" ,
"tool_run_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GET /tool-runs/{tool_run_id}/logs
Parameters Example responses
200 Response {
"properties" : {
"logs" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"logs"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GET /tools/{tool_id}/runs
Parameters Enumerated Values Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"tool_runs" : {
"items" : {
"properties" : {
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"input" : { } ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"runtime_path" : {
"type" : "string"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"completed_at" ,
"created_at" ,
"created_by" ,
"input" ,
"runtime_path" ,
"started_at" ,
"status" ,
"tool_id" ,
"tool_run_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"tool_runs"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GET /tools
Parameters Example responses
200 Response {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"tools" : {
"items" : {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_config_file" : {
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"tool_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"tools"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
POST /tools
Body parameter
{
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tool_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Parameters Example responses
201 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_config_file" : {
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"tool_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
DELETE /tools/{tool_id}
Parameters Example responses
400 Response {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GET /tools/{tool_id}
Parameters Example responses
200 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_config_file" : {
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"tool_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
PATCH /tools/{tool_id}
Body parameter
{
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tool_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Parameters Example responses
200 Response {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_config_file" : {
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"tool_id" ,
"updated_at"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
POST /tools/{tool_id}/activities/{activity_path}
Body parameter
Parameters Example responses
200 Response Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
GET /tools/{tool_id}/openapi
Parameters Example responses
200 Response Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Usage GetUsage GET /usage
Example responses
200 Response {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"bytes_ingested_limit" : {
"type" : "number"
} ,
"rag_queries" : {
"type" : "number"
} ,
"rag_queries_limit" : {
"type" : "number"
} ,
"runtime_seconds" : {
"type" : "number"
} ,
"runtime_seconds_limit" : {
"type" : "number"
} ,
"usage_period_end" : {
"format" : "date-time" ,
"type" : "string"
} ,
"usage_period_start" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bytes_ingested" ,
"bytes_ingested_limit" ,
"rag_queries" ,
"rag_queries_limit" ,
"runtime_seconds" ,
"runtime_seconds_limit" ,
"usage_period_end" ,
"usage_period_start"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Users GetUser GET /users/{user_id}
Parameters Example responses
200 Response {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organizations" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"user_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"email" ,
"organizations" ,
"updated_at" ,
"user_id"
] ,
"type" : "object"
} Responses
Warning To perform this operation, you must be authenticated by means of one of the following methods:
smithy.api.httpBearerAuth
Schemas ActivityDuration {
"properties" : {
"activity_type" : {
"type" : "string"
} ,
"seconds" : {
"type" : "number"
}
} ,
"type" : "object"
} Properties ApiKeyDetail {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties Artifact {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} Properties AssertUrlOperation {
"enum" : [
"PUT" ,
"GET"
] ,
"type" : "string"
} Properties Enumerated Values AssetDetail {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"contents" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"size" : {
"type" : "number"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties AssistantDetail {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"description" ,
"knowledge_base_ids" ,
"name" ,
"organization_id" ,
"retriever_ids" ,
"ruleset_ids" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Properties AssistantEventDetail {
"properties" : {
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"event_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"origin" : {
"type" : "string"
} ,
"payload" : { } ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"assistant_run_id" ,
"created_at" ,
"event_id" ,
"origin" ,
"payload" ,
"timestamp" ,
"type"
] ,
"type" : "object"
} Properties AssistantRunDetail {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"output" : { } ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"assistant_id" ,
"assistant_run_id" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"knowledge_base_ids" ,
"retriever_ids" ,
"ruleset_ids" ,
"status" ,
"stream" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Properties AssistantRunStatus {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} Properties Enumerated Values BucketDetail {
"properties" : {
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bucket_id" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CancelAssistantRunResponseContent {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"output" : { } ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"assistant_id" ,
"assistant_run_id" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"knowledge_base_ids" ,
"retriever_ids" ,
"ruleset_ids" ,
"status" ,
"stream" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Properties CancelDataJobResponseContent {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"data_connector_id" ,
"data_job_id" ,
"status"
] ,
"type" : "object"
} Properties CancelKnowledgeBaseJobResponseContent {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_job_id" ,
"status"
] ,
"type" : "object"
} Properties CancelStructureRunResponseContent {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"started_at" ,
"status" ,
"structure_id" ,
"structure_run_id" ,
"updated_at"
] ,
"type" : "object"
} Properties ChatMessageDriverConfiguration {
"properties" : {
"extra_params" : { } ,
"max_tokens" : {
"type" : "number"
} ,
"model" : {
"type" : "string"
} ,
"structured_output_strategy" : {
"type" : "string"
} ,
"temperature" : {
"format" : "float" ,
"type" : "number"
} ,
"use_native_tools" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Properties ChatMessageMessage {
"properties" : {
"content" : {
"items" : {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"role" : {
"type" : "string"
} ,
"usage" : {
"properties" : {
"input_tokens" : {
"type" : "number"
} ,
"output_tokens" : {
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"input_tokens" ,
"output_tokens" ,
"type"
] ,
"type" : "object"
}
} ,
"required" : [
"content" ,
"role" ,
"usage"
] ,
"type" : "object"
} Properties {
"properties" : {
"activities" : {
"items" : {
"properties" : {
"description" : {
"type" : "string"
} ,
"json_schema" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"description" ,
"json_schema" ,
"name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"activities" ,
"name"
] ,
"type" : "object"
} Properties {
"properties" : {
"description" : {
"type" : "string"
} ,
"json_schema" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"description" ,
"json_schema" ,
"name"
] ,
"type" : "object"
} Properties ChatMessageUsage {
"properties" : {
"input_tokens" : {
"type" : "number"
} ,
"output_tokens" : {
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"input_tokens" ,
"output_tokens" ,
"type"
] ,
"type" : "object"
} Properties ClientErrorResponseContent {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Properties CodeSource {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} Properties oneOf
xor
{
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"access_token" : {
"maxLength" : 1000 ,
"minLength" : 1 ,
"type" : "string"
} ,
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
}
]
} Properties ConfluenceDetail {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
} Properties {
"properties" : {
"atlassian_api_token" : {
"type" : "string"
} ,
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_api_token" ,
"atlassian_email" ,
"domain"
] ,
"type" : "object"
} Properties {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"auth_code" : {
"type" : "string"
}
} ,
"required" : [
"auth_code"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
}
]
} Properties ConnectionDetail {
"properties" : {
"connection_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"connection_id" ,
"created_at" ,
"created_by" ,
"name" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateApiKeyRequestContent {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateApiKeyResponseContent {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at" ,
"value"
] ,
"type" : "object"
} Properties CreateAssetRequestContent {
"properties" : {
"name" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateAssetResponseContent {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"contents" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"size" : {
"type" : "number"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateAssetUrlRequestContent {
"properties" : {
"operation" : {
"enum" : [
"PUT" ,
"GET"
] ,
"type" : "string"
}
} ,
"type" : "object"
} Properties CreateAssetUrlResponseContent {
"properties" : {
"headers" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"url" : {
"type" : "string"
}
} ,
"required" : [
"headers" ,
"url"
] ,
"type" : "object"
} Properties CreateAssistantRequestContent {
"properties" : {
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateAssistantResponseContent {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"description" ,
"knowledge_base_ids" ,
"name" ,
"organization_id" ,
"retriever_ids" ,
"ruleset_ids" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateAssistantRunRequestContent {
"properties" : {
"additional_knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"additional_retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"additional_ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"additional_structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"additional_tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"new_thread" : {
"description" : "If true, create a new thread for this run to be returned in the response thread_id." ,
"type" : "boolean"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"description" : "If provided, the run will be associated with the given thread. This takes precedence over new_thread." ,
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties CreateAssistantRunResponseContent {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"output" : { } ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"assistant_id" ,
"assistant_run_id" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"knowledge_base_ids" ,
"retriever_ids" ,
"ruleset_ids" ,
"status" ,
"stream" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateBillingManagementUrlResponseContent {
"properties" : {
"billing_management_url" : {
"type" : "string"
}
} ,
"required" : [
"billing_management_url"
] ,
"type" : "object"
} Properties CreateBucketRequestContent {
"properties" : {
"name" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateBucketResponseContent {
"properties" : {
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bucket_id" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateChatMessageRequestContent {
"properties" : {
"driver_configuration" : {
"properties" : {
"extra_params" : { } ,
"max_tokens" : {
"type" : "number"
} ,
"model" : {
"type" : "string"
} ,
"structured_output_strategy" : {
"type" : "string"
} ,
"temperature" : {
"format" : "float" ,
"type" : "number"
} ,
"use_native_tools" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
"messages" : {
"items" : {
"properties" : {
"content" : {
"items" : {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"role" : {
"type" : "string"
} ,
"usage" : {
"properties" : {
"input_tokens" : {
"type" : "number"
} ,
"output_tokens" : {
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"input_tokens" ,
"output_tokens" ,
"type"
] ,
"type" : "object"
}
} ,
"required" : [
"content" ,
"role" ,
"usage"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output_schema" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} ,
"tools" : {
"items" : {
"properties" : {
"activities" : {
"items" : {
"properties" : {
"description" : {
"type" : "string"
} ,
"json_schema" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"description" ,
"json_schema" ,
"name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"activities" ,
"name"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"driver_configuration" ,
"messages" ,
"output_schema" ,
"tools"
] ,
"type" : "object"
} Properties CreateChatMessageResponseContent {
"properties" : {
"content" : {
"items" : {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"role" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"usage" : {
"properties" : {
"input_tokens" : {
"type" : "number"
} ,
"output_tokens" : {
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"input_tokens" ,
"output_tokens" ,
"type"
] ,
"type" : "object"
}
} ,
"required" : [
"content" ,
"role" ,
"type" ,
"usage"
] ,
"type" : "object"
} Properties CreateChatMessageStreamRequestContent {
"properties" : {
"driver_configuration" : {
"properties" : {
"extra_params" : { } ,
"max_tokens" : {
"type" : "number"
} ,
"model" : {
"type" : "string"
} ,
"structured_output_strategy" : {
"type" : "string"
} ,
"temperature" : {
"format" : "float" ,
"type" : "number"
} ,
"use_native_tools" : {
"type" : "boolean"
}
} ,
"type" : "object"
} ,
"messages" : {
"items" : {
"properties" : {
"content" : {
"items" : {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"role" : {
"type" : "string"
} ,
"usage" : {
"properties" : {
"input_tokens" : {
"type" : "number"
} ,
"output_tokens" : {
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"input_tokens" ,
"output_tokens" ,
"type"
] ,
"type" : "object"
}
} ,
"required" : [
"content" ,
"role" ,
"usage"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output_schema" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} ,
"tools" : {
"items" : {
"properties" : {
"activities" : {
"items" : {
"properties" : {
"description" : {
"type" : "string"
} ,
"json_schema" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"description" ,
"json_schema" ,
"name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
}
} ,
"required" : [
"activities" ,
"name"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"driver_configuration" ,
"messages" ,
"output_schema" ,
"tools"
] ,
"type" : "object"
} Properties CreateChatMessageStreamResponseContent {
"properties" : {
"content" : {
"items" : {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"role" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"usage" : {
"properties" : {
"input_tokens" : {
"type" : "number"
} ,
"output_tokens" : {
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"input_tokens" ,
"output_tokens" ,
"type"
] ,
"type" : "object"
}
} ,
"required" : [
"content" ,
"role" ,
"type"
] ,
"type" : "object"
} Properties CreateCheckoutSessionRequestContent {
"properties" : {
"price_lookup_key" : {
"type" : "string"
}
} ,
"required" : [
"price_lookup_key"
] ,
"type" : "object"
} Properties CreateCheckoutSessionResponseContent {
"properties" : {
"redirect_url" : {
"type" : "string"
}
} ,
"required" : [
"redirect_url"
] ,
"type" : "object"
} Properties CreateConnectionRequestContent {
"properties" : {
"credentials" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"auth_code" : {
"type" : "string"
}
} ,
"required" : [
"auth_code"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
}
]
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"credentials" ,
"type"
] ,
"type" : "object"
} Properties CreateConnectionResponseContent {
"properties" : {
"connection_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"connection_id" ,
"created_at" ,
"created_by" ,
"name" ,
"type"
] ,
"type" : "object"
} Properties CreateDataConnectorRequestContent {
"properties" : {
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_api_token" : {
"type" : "string"
} ,
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_api_token" ,
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"auth_code" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"auth_code" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"aws_secret_access_key" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"aws_secret_access_key" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"name" ,
"type"
] ,
"type" : "object"
} Properties CreateDataConnectorResponseContent {
"properties" : {
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"schedule_expression" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"data_connector_id" ,
"name" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateDataJobResponseContent {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"data_connector_id" ,
"data_job_id" ,
"status"
] ,
"type" : "object"
} Properties CreateEventsRequestContent {
"properties" : {
"events" : {
"items" : {
"properties" : {
"payload" : { } ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"timestamp" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties CreateFunctionDeploymentRequestContent {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"access_token" : {
"maxLength" : 1000 ,
"minLength" : 1 ,
"type" : "string"
} ,
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
}
]
} ,
"force" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Properties CreateFunctionDeploymentResponseContent {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"function_id" ,
"status"
] ,
"type" : "object"
} Properties CreateFunctionExecutionGetOutputPayload Properties None
CreateFunctionExecutionPostInputPayload Properties None
CreateFunctionExecutionPostOutputPayload Properties None
CreateFunctionRequestContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateFunctionResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"function_id" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateIntegrationRequestContent {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_name"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"name" ,
"type"
] ,
"type" : "object"
} Properties CreateIntegrationResponseContent {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"integration_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_ids" ,
"config" ,
"created_at" ,
"created_by" ,
"description" ,
"integration_id" ,
"name" ,
"organization_id" ,
"structure_ids" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateInviteRequestContent {
"properties" : {
"email" : {
"maxLength" : 254 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"email"
] ,
"type" : "object"
} Properties CreateInviteResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"expires_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"invite_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"responded_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"ACCEPTED" ,
"EXPIRED" ,
"PENDING" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"email" ,
"expires_at" ,
"invite_id" ,
"organization_id" ,
"status"
] ,
"type" : "object"
} Properties CreateKnowledgeBaseJobResponseContent {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_job_id" ,
"status"
] ,
"type" : "object"
} Properties CreateKnowledgeBaseRequestContent {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"password"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"structured_columns" ,
"unstructured_columns"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"config" ,
"name" ,
"type"
] ,
"type" : "object"
} Properties CreateKnowledgeBaseResponseContent {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"asset_paths" ,
"config" ,
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateLibraryRequestContent {
"properties" : {
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"knowledge_base_configs" : {
"items" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"password"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"structured_columns" ,
"unstructured_columns"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"data_connector_ids" ,
"knowledge_base_configs" ,
"name"
] ,
"type" : "object"
} Properties CreateLibraryResponseContent {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"library_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"data_connector_ids" ,
"knowledge_base_ids" ,
"library_id" ,
"name" ,
"organization_id" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateMessageRequestContent {
"properties" : {
"input" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
}
} ,
"required" : [
"input" ,
"output"
] ,
"type" : "object"
} Properties CreateMessageResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"index" : {
"type" : "number"
} ,
"input" : {
"type" : "string"
} ,
"message_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"index" ,
"input" ,
"message_id" ,
"metadata" ,
"output" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateOrganizationApiKeyRequestContent {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateOrganizationApiKeyResponseContent {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at" ,
"value"
] ,
"type" : "object"
} Properties CreateOrganizationRequestContent {
"properties" : {
"description" : {
"maxLength" : 2000 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateOrganizationResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"default_bucket_id" : {
"type" : "string"
} ,
"description" : {
"maxLength" : 2000 ,
"type" : "string"
} ,
"entitlement" : {
"allOf" : [
{
"enum" : [
"FREE" ,
"PAID" ,
"PARTNER" ,
"UNPAID" ,
"EXPIRED"
] ,
"type" : "string"
} ,
{
"default" : "FREE"
}
]
} ,
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"default_bucket_id" ,
"description" ,
"entitlement" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties allOf
and
continued
CreateRetrieverComponentRequestContent {
"properties" : {
"config" : { } ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"config" ,
"name" ,
"type"
] ,
"type" : "object"
} Properties CreateRetrieverComponentResponseContent {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateRetrieverRequestContent {
"properties" : {
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"retriever_component_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateRetrieverResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"retriever_components_schema" : { } ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_components" ,
"retriever_components_schema" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateRuleRequestContent {
"properties" : {
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"rule" : {
"maxLength" : 2000 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name" ,
"rule"
] ,
"type" : "object"
} Properties CreateRuleResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule" : {
"type" : "string"
} ,
"rule_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule" ,
"rule_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateRulesetRequestContent {
"properties" : {
"alias" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateRulesetResponseContent {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"description" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule_ids" ,
"ruleset_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateSecretRequestContent {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"value" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} Properties CreateSecretResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"secret_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"last_used" ,
"name" ,
"organization_id" ,
"secret_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateStructureDeploymentRequestContent {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"access_token" : {
"maxLength" : 1000 ,
"minLength" : 1 ,
"type" : "string"
} ,
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
}
]
} ,
"force" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Properties CreateStructureDeploymentResponseContent {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status" ,
"structure_id"
] ,
"type" : "object"
} Properties CreateStructureRequestContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"structure_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateStructureResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Properties CreateStructureRunRequestContent {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"args"
] ,
"type" : "object"
} Properties CreateStructureRunResponseContent {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"started_at" ,
"status" ,
"structure_id" ,
"structure_run_id" ,
"updated_at"
] ,
"type" : "object"
} Properties CreateThreadRequestContent {
"properties" : {
"alias" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"messages" : {
"items" : {
"properties" : {
"input" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
}
} ,
"required" : [
"input" ,
"output"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateThreadResponseContent {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Properties Properties None
Properties None
CreateToolDeploymentRequestContent {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"access_token" : {
"maxLength" : 1000 ,
"minLength" : 1 ,
"type" : "string"
} ,
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
}
]
} ,
"force" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Properties CreateToolDeploymentResponseContent {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status" ,
"tool_id"
] ,
"type" : "object"
} Properties CreateToolRequestContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tool_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"name"
] ,
"type" : "object"
} Properties CreateToolResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_config_file" : {
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"tool_id" ,
"updated_at"
] ,
"type" : "object"
} Properties {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_api_token" : {
"type" : "string"
} ,
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_api_token" ,
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"auth_code" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"auth_code" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"aws_secret_access_key" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"aws_secret_access_key" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} Properties oneOf
xor
xor
xor
xor
xor
DataConnectorConfigUnion {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} Properties oneOf
xor
xor
xor
xor
xor
DataConnectorDetail {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"data_connector_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties DataJobDetail {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"data_connector_id" ,
"data_job_id" ,
"status"
] ,
"type" : "object"
} Properties DataJobStatus {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} Properties Enumerated Values DataLakeCodeSource {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
} Properties DataLakeConnectorDetail {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
} Properties {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"bucket_id"
] ,
"type" : "object"
} Properties DataLakeFunctionCode {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
} Properties DataLakeStructureCode {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
} Properties {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
} Properties DefaultFunctionCode Properties None
DefaultStructureCode Properties None
Properties None
DeploymentCountGauge {
"properties" : {
"active_count" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
}
} ,
"type" : "object"
} Properties DeploymentDurationGauge {
"properties" : {
"total_seconds" : {
"type" : "number"
}
} ,
"type" : "object"
} Properties DeploymentErrorRateGauge {
"properties" : {
"rate" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} Properties DeploymentStatus {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} Properties Enumerated Values DurationPlot {
"properties" : {
"seconds_avg" : {
"type" : "number"
} ,
"seconds_p100" : {
"type" : "number"
} ,
"seconds_p50" : {
"type" : "number"
} ,
"timeseries" : {
"items" : {
"properties" : {
"seconds_p0" : {
"type" : "number"
} ,
"seconds_p100" : {
"type" : "number"
} ,
"seconds_p50" : {
"type" : "number"
} ,
"time" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties DurationTimeseriesElement {
"properties" : {
"seconds_p0" : {
"type" : "number"
} ,
"seconds_p100" : {
"type" : "number"
} ,
"seconds_p50" : {
"type" : "number"
} ,
"time" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"type" : "object"
} Properties EmbeddingModel {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} Properties Enumerated Values Entitlement {
"enum" : [
"FREE" ,
"PAID" ,
"PARTNER" ,
"UNPAID" ,
"EXPIRED"
] ,
"type" : "string"
} Properties Enumerated Values Entry {
"properties" : {
"id" : {
"type" : "string"
} ,
"meta" : {
"additionalProperties" : {
"type" : "string"
} ,
"type" : "object"
} ,
"namespace" : {
"type" : "string"
} ,
"score" : {
"format" : "float" ,
"type" : "number"
} ,
"vector" : {
"items" : {
"format" : "float" ,
"type" : "number"
} ,
"type" : "array"
}
} ,
"required" : [
"id" ,
"score"
] ,
"type" : "object"
} Properties EnvVar {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} Properties EnvVarSource {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} Properties Enumerated Values Error {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} Properties ErrorRateGauge {
"properties" : {
"error_type_counts" : {
"items" : {
"properties" : {
"count" : {
"type" : "number"
} ,
"error_type" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"rate" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} Properties ErrorTypeCount {
"properties" : {
"count" : {
"type" : "number"
} ,
"error_type" : {
"type" : "string"
}
} ,
"type" : "object"
} Properties EventDetail {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"event_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"origin" : {
"type" : "string"
} ,
"payload" : { } ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"event_id" ,
"origin" ,
"payload" ,
"structure_run_id" ,
"timestamp" ,
"type"
] ,
"type" : "object"
} Properties {
"properties" : {
"payload" : { } ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"timestamp" ,
"type"
] ,
"type" : "object"
} Properties FunctionCode {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} Properties oneOf
xor
xor
FunctionDeploymentDetail {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"function_id" ,
"status"
] ,
"type" : "object"
} Properties FunctionDetail {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"function_id" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties FunctionRunDetail {
"properties" : {
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"input" : { } ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"runtime_path" : {
"type" : "string"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"completed_at" ,
"created_at" ,
"created_by" ,
"function_id" ,
"function_run_id" ,
"input" ,
"runtime_path" ,
"started_at" ,
"status" ,
"updated_at"
] ,
"type" : "object"
} Properties FunctionRunStatus {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} Properties Enumerated Values GTCHybidSQLPGVectorKnowledgeBaseDetail {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
} Properties {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"structured_columns" ,
"unstructured_columns"
] ,
"type" : "object"
} Properties GTCPGVectorKnowledgeBaseDetail {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
} Properties {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Properties GetApiKeyResponseContent {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetAssetResponseContent {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"contents" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"size" : {
"type" : "number"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetAssistantResponseContent {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"description" ,
"knowledge_base_ids" ,
"name" ,
"organization_id" ,
"retriever_ids" ,
"ruleset_ids" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Properties GetAssistantRunEventsSSEOutputPayload {
"format" : "byte" ,
"type" : "string"
} Properties GetAssistantRunResponseContent {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"output" : { } ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"assistant_id" ,
"assistant_run_id" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"knowledge_base_ids" ,
"retriever_ids" ,
"ruleset_ids" ,
"status" ,
"stream" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Properties GetBucketResponseContent {
"properties" : {
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bucket_id" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetConfigResponseContent {
"properties" : {
"data_lake_s3_bucket" : {
"type" : "string"
} ,
"data_lake_s3_region" : {
"type" : "string"
} ,
"data_lake_s3_url" : {
"type" : "string"
} ,
"google_drive_data_connector_client_id" : {
"type" : "string"
}
} ,
"required" : [
"data_lake_s3_bucket" ,
"data_lake_s3_region" ,
"data_lake_s3_url" ,
"google_drive_data_connector_client_id"
] ,
"type" : "object"
} Properties GetDataConnectorResponseContent {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"data_connector_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties GetDataJobResponseContent {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"data_connector_id" ,
"data_job_id" ,
"status"
] ,
"type" : "object"
} Properties GetDeploymentResponseContent {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status"
] ,
"type" : "object"
} Properties GetEventResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"event_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"origin" : {
"type" : "string"
} ,
"payload" : { } ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"event_id" ,
"origin" ,
"payload" ,
"structure_run_id" ,
"timestamp" ,
"type"
] ,
"type" : "object"
} Properties GetFunctionResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"function_id" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetFunctionRunResponseContent {
"properties" : {
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"input" : { } ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"runtime_path" : {
"type" : "string"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"completed_at" ,
"created_at" ,
"created_by" ,
"function_id" ,
"function_run_id" ,
"input" ,
"runtime_path" ,
"started_at" ,
"status" ,
"updated_at"
] ,
"type" : "object"
} Properties GetIntegrationResponseContent {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"integration_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_ids" ,
"config" ,
"created_at" ,
"created_by" ,
"description" ,
"integration_id" ,
"name" ,
"organization_id" ,
"structure_ids" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties GetInviteResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"expires_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"invite_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"responded_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"ACCEPTED" ,
"EXPIRED" ,
"PENDING" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"email" ,
"expires_at" ,
"invite_id" ,
"organization_id" ,
"status"
] ,
"type" : "object"
} Properties GetKnowledgeBaseJobResponseContent {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_job_id" ,
"status"
] ,
"type" : "object"
} Properties GetKnowledgeBaseQueryResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"entries" : {
"items" : {
"properties" : {
"id" : {
"type" : "string"
} ,
"meta" : {
"additionalProperties" : {
"type" : "string"
} ,
"type" : "object"
} ,
"namespace" : {
"type" : "string"
} ,
"score" : {
"format" : "float" ,
"type" : "number"
} ,
"vector" : {
"items" : {
"format" : "float" ,
"type" : "number"
} ,
"type" : "array"
}
} ,
"required" : [
"id" ,
"score"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_query_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"entries" ,
"knowledge_base_id" ,
"knowledge_base_query_id" ,
"query"
] ,
"type" : "object"
} Properties GetKnowledgeBaseResponseContent {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"asset_paths" ,
"config" ,
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties GetKnowledgeBaseSearchResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_search_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
} ,
"result" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_search_id" ,
"query" ,
"result"
] ,
"type" : "object"
} Properties GetLibraryResponseContent {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"library_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"data_connector_ids" ,
"knowledge_base_ids" ,
"library_id" ,
"name" ,
"organization_id" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetMessageResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"index" : {
"type" : "number"
} ,
"input" : {
"type" : "string"
} ,
"message_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"index" ,
"input" ,
"message_id" ,
"metadata" ,
"output" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetOrganizationResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"default_bucket_id" : {
"type" : "string"
} ,
"description" : {
"maxLength" : 2000 ,
"type" : "string"
} ,
"entitlement" : {
"allOf" : [
{
"enum" : [
"FREE" ,
"PAID" ,
"PARTNER" ,
"UNPAID" ,
"EXPIRED"
] ,
"type" : "string"
} ,
{
"default" : "FREE"
}
]
} ,
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"default_bucket_id" ,
"description" ,
"entitlement" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties allOf
and
continued
GetRetrieverComponentResponseContent {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties GetRetrieverResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"retriever_components_schema" : { } ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_components" ,
"retriever_components_schema" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetRuleResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule" : {
"type" : "string"
} ,
"rule_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule" ,
"rule_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetRulesetResponseContent {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"description" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule_ids" ,
"ruleset_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetSecretResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"secret_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"last_used" ,
"name" ,
"organization_id" ,
"secret_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetStructureResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Properties GetStructureRunEventsSSEOutputPayload {
"format" : "byte" ,
"type" : "string"
} Properties GetStructureRunResponseContent {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"started_at" ,
"status" ,
"structure_id" ,
"structure_run_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetStructuresDashboardResponseContent {
"properties" : {
"deployment_count_gauge" : {
"properties" : {
"active_count" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"deployment_duration_gauge" : {
"properties" : {
"total_seconds" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"deployment_error_rate_gauge" : {
"properties" : {
"rate" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} ,
"duration_plot" : {
"properties" : {
"seconds_avg" : {
"type" : "number"
} ,
"seconds_p100" : {
"type" : "number"
} ,
"seconds_p50" : {
"type" : "number"
} ,
"timeseries" : {
"items" : {
"properties" : {
"seconds_p0" : {
"type" : "number"
} ,
"seconds_p100" : {
"type" : "number"
} ,
"seconds_p50" : {
"type" : "number"
} ,
"time" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} ,
"error_rate_gauge" : {
"properties" : {
"error_type_counts" : {
"items" : {
"properties" : {
"count" : {
"type" : "number"
} ,
"error_type" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"rate" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} ,
"run_count_gauge" : {
"properties" : {
"active_count" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"run_duration_gauge" : {
"properties" : {
"activity_durations" : {
"items" : {
"properties" : {
"activity_type" : {
"type" : "string"
} ,
"seconds" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"total_seconds" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"token_count_gauge" : {
"properties" : {
"by_model" : {
"additionalProperties" : {
"properties" : {
"input" : {
"format" : "float" ,
"type" : "number"
} ,
"output" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} ,
"type" : "object"
} ,
"input" : {
"format" : "float" ,
"type" : "number"
} ,
"output" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
}
} ,
"type" : "object"
} Properties GetThreadResponseContent {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetTokenResponseContent {
"properties" : {
"access_token" : {
"type" : "string"
}
} ,
"required" : [
"access_token"
] ,
"type" : "object"
} Properties Properties None
GetToolResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_config_file" : {
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"tool_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetToolRunResponseContent {
"properties" : {
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"input" : { } ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"runtime_path" : {
"type" : "string"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"completed_at" ,
"created_at" ,
"created_by" ,
"input" ,
"runtime_path" ,
"started_at" ,
"status" ,
"tool_id" ,
"tool_run_id" ,
"updated_at"
] ,
"type" : "object"
} Properties GetUsageResponseContent {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"bytes_ingested_limit" : {
"type" : "number"
} ,
"rag_queries" : {
"type" : "number"
} ,
"rag_queries_limit" : {
"type" : "number"
} ,
"runtime_seconds" : {
"type" : "number"
} ,
"runtime_seconds_limit" : {
"type" : "number"
} ,
"usage_period_end" : {
"format" : "date-time" ,
"type" : "string"
} ,
"usage_period_start" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bytes_ingested" ,
"bytes_ingested_limit" ,
"rag_queries" ,
"rag_queries_limit" ,
"runtime_seconds" ,
"runtime_seconds_limit" ,
"usage_period_end" ,
"usage_period_start"
] ,
"type" : "object"
} Properties GetUserResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organizations" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"user_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"email" ,
"organizations" ,
"updated_at" ,
"user_id"
] ,
"type" : "object"
} Properties GitHubAppDetail {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
} Properties {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"type" : "object"
} Properties {
"properties" : {
"auth_code" : {
"type" : "string"
}
} ,
"required" : [
"auth_code"
] ,
"type" : "object"
} Properties GithubCodeSource {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties {
"properties" : {
"access_token" : {
"maxLength" : 1000 ,
"minLength" : 1 ,
"type" : "string"
} ,
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties GithubFunctionCode {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
} Properties GithubFunctionCodePushConfig {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
} Properties GithubStructureCode {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
} Properties GithubStructureCodePushConfig {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
} Properties {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
} Properties {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
} Properties GoogleDriveDetail {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
} Properties {
"properties" : {
"auth_code" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"auth_code" ,
"file_ids"
] ,
"type" : "object"
} Properties {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_name"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} Properties oneOf
xor
xor
IntegrationConfigUnion {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} Properties oneOf
xor
xor
IntegrationDetail {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"integration_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_ids" ,
"config" ,
"created_at" ,
"created_by" ,
"description" ,
"integration_id" ,
"name" ,
"organization_id" ,
"structure_ids" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties IntegrationType {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
} Properties Enumerated Values InviteDetail {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"expires_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"invite_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"responded_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"ACCEPTED" ,
"EXPIRED" ,
"PENDING" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"email" ,
"expires_at" ,
"invite_id" ,
"organization_id" ,
"status"
] ,
"type" : "object"
} Properties InviteResponseStatus {
"enum" : [
"ACCEPTED" ,
"REJECTED"
] ,
"type" : "string"
} Properties Enumerated Values InviteStatus {
"enum" : [
"ACCEPTED" ,
"EXPIRED" ,
"PENDING" ,
"REJECTED"
] ,
"type" : "string"
} Properties Enumerated Values InvokeStructureWebhookGetResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Properties InvokeStructureWebhookPostResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Properties JsonSchema {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"id" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"schema" : {
"type" : "string"
} ,
"title" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"id" ,
"properties" ,
"required" ,
"schema" ,
"title" ,
"type"
] ,
"type" : "object"
} Properties JsonSchemaProperties {
"properties" : {
"member" : {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : "[Circular]" ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
}
} ,
"type" : "object"
} Properties JsonSchemaProperty {
"properties" : {
"additionalProperties" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"properties" : {
"properties" : {
"member" : "[Circular]"
} ,
"type" : "object"
} ,
"required" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"additionalProperties" ,
"description" ,
"properties" ,
"required" ,
"type"
] ,
"type" : "object"
} Properties {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"password"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"structured_columns" ,
"unstructured_columns"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} Properties oneOf
xor
xor
xor
KnowledgeBaseConfigUnion {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} Properties oneOf
xor
xor
xor
KnowledgeBaseDetail {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"asset_paths" ,
"config" ,
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties KnowledgeBaseJobDetail {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_job_id" ,
"status"
] ,
"type" : "object"
} Properties KnowledgeBaseJobStatus {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} Properties Enumerated Values KnowledgeBaseQueryDetail {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"entries" : {
"items" : {
"properties" : {
"id" : {
"type" : "string"
} ,
"meta" : {
"additionalProperties" : {
"type" : "string"
} ,
"type" : "object"
} ,
"namespace" : {
"type" : "string"
} ,
"score" : {
"format" : "float" ,
"type" : "number"
} ,
"vector" : {
"items" : {
"format" : "float" ,
"type" : "number"
} ,
"type" : "array"
}
} ,
"required" : [
"id" ,
"score"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_query_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"entries" ,
"knowledge_base_id" ,
"knowledge_base_query_id" ,
"query"
] ,
"type" : "object"
} Properties KnowledgeBaseSearchDetail {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_search_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
} ,
"result" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_search_id" ,
"query" ,
"result"
] ,
"type" : "object"
} Properties LibraryDetail {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"library_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"data_connector_ids" ,
"knowledge_base_ids" ,
"library_id" ,
"name" ,
"organization_id" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Properties ListApiKeysResponseContent {
"properties" : {
"api_keys" : {
"items" : {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"api_keys" ,
"pagination"
] ,
"type" : "object"
} Properties ListAssetsResponseContent {
"properties" : {
"assets" : {
"items" : {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"contents" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"size" : {
"type" : "number"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"postfix" : {
"type" : "string"
} ,
"prefix" : {
"type" : "string"
}
} ,
"required" : [
"assets" ,
"pagination"
] ,
"type" : "object"
} Properties ListAssistantEventsResponseContent {
"properties" : {
"count" : {
"type" : "number"
} ,
"events" : {
"items" : {
"properties" : {
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"event_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"origin" : {
"type" : "string"
} ,
"payload" : { } ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"assistant_run_id" ,
"created_at" ,
"event_id" ,
"origin" ,
"payload" ,
"timestamp" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"limit" : {
"type" : "number"
} ,
"next_offset" : {
"type" : "number"
} ,
"offset" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
}
} ,
"required" : [
"count" ,
"events" ,
"limit" ,
"next_offset" ,
"offset" ,
"total_count"
] ,
"type" : "object"
} Properties ListAssistantRunsResponseContent {
"properties" : {
"assistant_runs" : {
"items" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"assistant_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"output" : { } ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"stream" : {
"type" : "boolean"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"assistant_id" ,
"assistant_run_id" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"knowledge_base_ids" ,
"retriever_ids" ,
"ruleset_ids" ,
"status" ,
"stream" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"assistant_runs" ,
"pagination"
] ,
"type" : "object"
} Properties ListAssistantsResponseContent {
"properties" : {
"assistants" : {
"items" : {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"description" ,
"knowledge_base_ids" ,
"name" ,
"organization_id" ,
"retriever_ids" ,
"ruleset_ids" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"assistants" ,
"pagination"
] ,
"type" : "object"
} Properties ListBucketsResponseContent {
"properties" : {
"buckets" : {
"items" : {
"properties" : {
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bucket_id" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"buckets" ,
"pagination"
] ,
"type" : "object"
} Properties ListConnectionsResponseContent {
"properties" : {
"connections" : {
"items" : {
"properties" : {
"connection_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"connection_id" ,
"created_at" ,
"created_by" ,
"name" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties ListDataConnectorsResponseContent {
"properties" : {
"data_connectors" : {
"items" : {
"properties" : {
"bucket_id" : {
"type" : "string"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"data_connector_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"data_connectors" ,
"pagination"
] ,
"type" : "object"
} Properties ListDataJobsResponseContent {
"properties" : {
"data_jobs" : {
"items" : {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"data_connector_id" ,
"data_job_id" ,
"status"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"data_jobs" ,
"pagination"
] ,
"type" : "object"
} Properties ListEventsResponseContent {
"properties" : {
"count" : {
"type" : "number"
} ,
"events" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"event_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"origin" : {
"type" : "string"
} ,
"payload" : { } ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"event_id" ,
"origin" ,
"payload" ,
"structure_run_id" ,
"timestamp" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"limit" : {
"type" : "number"
} ,
"next_offset" : {
"type" : "number"
} ,
"offset" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
}
} ,
"required" : [
"count" ,
"events" ,
"limit" ,
"next_offset" ,
"offset" ,
"total_count"
] ,
"type" : "object"
} Properties ListFunctionDeploymentsResponseContent {
"properties" : {
"deployments" : {
"items" : {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"function_id" ,
"status"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"deployments" ,
"pagination"
] ,
"type" : "object"
} Properties ListFunctionRunLogsResponseContent {
"properties" : {
"logs" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"logs"
] ,
"type" : "object"
} Properties ListFunctionRunsResponseContent {
"properties" : {
"function_runs" : {
"items" : {
"properties" : {
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"function_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"input" : { } ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"runtime_path" : {
"type" : "string"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"completed_at" ,
"created_at" ,
"created_by" ,
"function_id" ,
"function_run_id" ,
"input" ,
"runtime_path" ,
"started_at" ,
"status" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"function_runs" ,
"pagination"
] ,
"type" : "object"
} Properties ListFunctionsResponseContent {
"properties" : {
"functions" : {
"items" : {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"function_id" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"functions" ,
"pagination"
] ,
"type" : "object"
} Properties ListIntegrationsResponseContent {
"properties" : {
"integrations" : {
"items" : {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"integration_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_ids" ,
"config" ,
"created_at" ,
"created_by" ,
"description" ,
"integration_id" ,
"name" ,
"organization_id" ,
"structure_ids" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"integrations" ,
"pagination"
] ,
"type" : "object"
} Properties ListInvitesResponseContent {
"properties" : {
"invites" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"expires_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"invite_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"responded_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"ACCEPTED" ,
"EXPIRED" ,
"PENDING" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"email" ,
"expires_at" ,
"invite_id" ,
"organization_id" ,
"status"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"invites" ,
"pagination"
] ,
"type" : "object"
} Properties ListKnowledgeBaseJobsResponseContent {
"properties" : {
"knowledge_base_jobs" : {
"items" : {
"properties" : {
"bytes_ingested" : {
"type" : "number"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"errors" : {
"items" : {
"properties" : {
"message" : {
"type" : "string"
} ,
"path" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"message" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { }
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_job_id" ,
"status"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"knowledge_base_jobs" ,
"pagination"
] ,
"type" : "object"
} Properties ListKnowledgeBaseQueriesResponseContent {
"properties" : {
"knowledge_base_queries" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"entries" : {
"items" : {
"properties" : {
"id" : {
"type" : "string"
} ,
"meta" : {
"additionalProperties" : {
"type" : "string"
} ,
"type" : "object"
} ,
"namespace" : {
"type" : "string"
} ,
"score" : {
"format" : "float" ,
"type" : "number"
} ,
"vector" : {
"items" : {
"format" : "float" ,
"type" : "number"
} ,
"type" : "array"
}
} ,
"required" : [
"id" ,
"score"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_query_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"entries" ,
"knowledge_base_id" ,
"knowledge_base_query_id" ,
"query"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties ListKnowledgeBaseSearchesResponseContent {
"properties" : {
"knowledge_base_searches" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_search_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
} ,
"result" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_search_id" ,
"query" ,
"result"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties ListKnowledgeBasesResponseContent {
"properties" : {
"knowledge_bases" : {
"items" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"asset_paths" ,
"config" ,
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"knowledge_bases" ,
"pagination"
] ,
"type" : "object"
} Properties ListLibrariesResponseContent {
"properties" : {
"libraries" : {
"items" : {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"library_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"data_connector_ids" ,
"knowledge_base_ids" ,
"library_id" ,
"name" ,
"organization_id" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"libraries" ,
"pagination"
] ,
"type" : "object"
} Properties ListMessagesResponseContent {
"properties" : {
"messages" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"index" : {
"type" : "number"
} ,
"input" : {
"type" : "string"
} ,
"message_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"index" ,
"input" ,
"message_id" ,
"metadata" ,
"output" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"messages" ,
"pagination"
] ,
"type" : "object"
} Properties ListModelsResponseContent {
"properties" : {
"models" : {
"items" : {
"properties" : {
"default" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"model_name" : {
"type" : "string"
} ,
"model_type" : {
"enum" : [
"chat" ,
"embedding" ,
"rerank" ,
"image_generation" ,
"unknown"
] ,
"type" : "string"
}
} ,
"required" : [
"default" ,
"model_name" ,
"model_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"models" ,
"pagination"
] ,
"type" : "object"
} Properties ListOrganizationApiKeysResponseContent {
"properties" : {
"api_keys" : {
"items" : {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"api_keys" ,
"pagination"
] ,
"type" : "object"
} Properties ListOrganizationUsersResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"users" : {
"items" : {
"properties" : {
"email" : {
"type" : "string"
} ,
"user_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"email" ,
"user_id"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"users"
] ,
"type" : "object"
} Properties ListOrganizationsResponseContent {
"properties" : {
"organizations" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"default_bucket_id" : {
"type" : "string"
} ,
"description" : {
"maxLength" : 2000 ,
"type" : "string"
} ,
"entitlement" : {
"allOf" : [
{
"enum" : [
"FREE" ,
"PAID" ,
"PARTNER" ,
"UNPAID" ,
"EXPIRED"
] ,
"type" : "string"
} ,
{
"default" : "FREE"
}
]
} ,
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"default_bucket_id" ,
"description" ,
"entitlement" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties ListRetrieverComponentsResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"retriever_components"
] ,
"type" : "object"
} Properties ListRetrieversResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"retrievers" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"retriever_components_schema" : { } ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_components" ,
"retriever_components_schema" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"retrievers"
] ,
"type" : "object"
} Properties ListRulesResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"rules" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule" : {
"type" : "string"
} ,
"rule_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule" ,
"rule_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"rules"
] ,
"type" : "object"
} Properties ListRulesetsResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"rulesets" : {
"items" : {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"description" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule_ids" ,
"ruleset_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"rulesets"
] ,
"type" : "object"
} Properties ListSecretsResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"secrets" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"secret_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"last_used" ,
"name" ,
"organization_id" ,
"secret_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"secrets"
] ,
"type" : "object"
} Properties ListSpansResponseContent {
"properties" : {
"page" : {
"type" : "number"
} ,
"spans" : {
"items" : {
"properties" : {
"attributes" : { } ,
"end_time" : {
"format" : "date-time" ,
"type" : "string"
} ,
"events" : {
"properties" : {
"attributes" : { } ,
"name" : {
"type" : "string"
} ,
"timestamp" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"attributes" ,
"name" ,
"timestamp"
] ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"parent_id" : {
"type" : "string"
} ,
"span_id" : {
"type" : "string"
} ,
"start_time" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"UNSET" ,
"OK" ,
"ERROR"
] ,
"type" : "string"
} ,
"trace_id" : {
"type" : "string"
}
} ,
"required" : [
"attributes" ,
"end_time" ,
"events" ,
"name" ,
"span_id" ,
"start_time" ,
"status" ,
"trace_id"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"spans"
] ,
"type" : "object"
} Properties ListStructureDeploymentsResponseContent {
"properties" : {
"deployments" : {
"items" : {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status" ,
"structure_id"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"deployments" ,
"pagination"
] ,
"type" : "object"
} Properties ListStructureRunLogsResponseContent {
"properties" : {
"logs" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"logs"
] ,
"type" : "object"
} Properties ListStructureRunsResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"structure_runs" : {
"items" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"started_at" ,
"status" ,
"structure_id" ,
"structure_run_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"structure_runs"
] ,
"type" : "object"
} Properties ListStructuresResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"structures" : {
"items" : {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"structures"
] ,
"type" : "object"
} Properties ListThreadsResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"threads" : {
"items" : {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"threads"
] ,
"type" : "object"
} Properties ListToolDeploymentsResponseContent {
"properties" : {
"deployments" : {
"items" : {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status" ,
"tool_id"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"deployments" ,
"pagination"
] ,
"type" : "object"
} Properties ListToolRunLogsResponseContent {
"properties" : {
"logs" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"logs"
] ,
"type" : "object"
} Properties ListToolRunsResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"tool_runs" : {
"items" : {
"properties" : {
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"input" : { } ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"runtime_path" : {
"type" : "string"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"completed_at" ,
"created_at" ,
"created_by" ,
"input" ,
"runtime_path" ,
"started_at" ,
"status" ,
"tool_id" ,
"tool_run_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"tool_runs"
] ,
"type" : "object"
} Properties ListToolsResponseContent {
"properties" : {
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} ,
"tools" : {
"items" : {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_config_file" : {
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"tool_id" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"required" : [
"pagination" ,
"tools"
] ,
"type" : "object"
} Properties ListUserInvitesResponseContent {
"properties" : {
"invites" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"expires_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"invite_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"responded_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"ACCEPTED" ,
"EXPIRED" ,
"PENDING" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"email" ,
"expires_at" ,
"invite_id" ,
"organization_id" ,
"status"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"pagination" : {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
}
} ,
"required" : [
"invites" ,
"pagination"
] ,
"type" : "object"
} Properties ListUsersResponseContent {
"properties" : {
"users" : {
"items" : {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organizations" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"user_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"email" ,
"organizations" ,
"updated_at" ,
"user_id"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties MessageContent {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} Properties MessageDetail {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"index" : {
"type" : "number"
} ,
"input" : {
"type" : "string"
} ,
"message_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"index" ,
"input" ,
"message_id" ,
"metadata" ,
"output" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Properties {
"properties" : {
"input" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
}
} ,
"required" : [
"input" ,
"output"
] ,
"type" : "object"
} Properties {
"additionalProperties" : {
"type" : "string"
} ,
"type" : "object"
} Properties {
"additionalProperties" : { } ,
"type" : "object"
} Properties ModelDetail {
"properties" : {
"default" : {
"type" : "boolean"
} ,
"description" : {
"type" : "string"
} ,
"model_name" : {
"type" : "string"
} ,
"model_type" : {
"enum" : [
"chat" ,
"embedding" ,
"rerank" ,
"image_generation" ,
"unknown"
] ,
"type" : "string"
}
} ,
"required" : [
"default" ,
"model_name" ,
"model_type"
] ,
"type" : "object"
} Properties ModelTokenCounts {
"properties" : {
"input" : {
"format" : "float" ,
"type" : "number"
} ,
"output" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} Properties ModelTokenCountsMap {
"additionalProperties" : {
"properties" : {
"input" : {
"format" : "float" ,
"type" : "number"
} ,
"output" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} ,
"type" : "object"
} Properties ModelType {
"enum" : [
"chat" ,
"embedding" ,
"rerank" ,
"image_generation" ,
"unknown"
] ,
"type" : "string"
} Properties Enumerated Values ObservabilityEvent {
"properties" : {
"attributes" : { } ,
"name" : {
"type" : "string"
} ,
"timestamp" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"attributes" ,
"name" ,
"timestamp"
] ,
"type" : "object"
} Properties OrganizationDetail {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"default_bucket_id" : {
"type" : "string"
} ,
"description" : {
"maxLength" : 2000 ,
"type" : "string"
} ,
"entitlement" : {
"allOf" : [
{
"enum" : [
"FREE" ,
"PAID" ,
"PARTNER" ,
"UNPAID" ,
"EXPIRED"
] ,
"type" : "string"
} ,
{
"default" : "FREE"
}
]
} ,
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"default_bucket_id" ,
"description" ,
"entitlement" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties allOf
and
continued
OrganizationModelConfig {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} Properties OrganizationUserDetail {
"properties" : {
"email" : {
"type" : "string"
} ,
"user_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"email" ,
"user_id"
] ,
"type" : "object"
} Properties PGAIKnowledgeBaseKnowledgeBaseDetail {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
} Properties Properties None
PGVectorKnowledgeBaseDetail {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
} Properties {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"password"
] ,
"type" : "object"
} Properties {
"properties" : {
"next_page" : {
"type" : "number"
} ,
"page_number" : {
"type" : "number"
} ,
"page_size" : {
"type" : "number"
} ,
"previous_page" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
} ,
"total_pages" : {
"type" : "number"
}
} ,
"required" : [
"page_number" ,
"page_size" ,
"total_count" ,
"total_pages"
] ,
"type" : "object"
} Properties Period {
"enum" : [
"1m" ,
"1h" ,
"1d" ,
"1w"
] ,
"type" : "string"
} Properties Enumerated Values QueryKnowledgeBaseRequestContent {
"properties" : {
"query" : {
"type" : "string"
} ,
"query_args" : { }
} ,
"type" : "object"
} Properties QueryKnowledgeBaseResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"entries" : {
"items" : {
"properties" : {
"id" : {
"type" : "string"
} ,
"meta" : {
"additionalProperties" : {
"type" : "string"
} ,
"type" : "object"
} ,
"namespace" : {
"type" : "string"
} ,
"score" : {
"format" : "float" ,
"type" : "number"
} ,
"vector" : {
"items" : {
"format" : "float" ,
"type" : "number"
} ,
"type" : "array"
}
} ,
"required" : [
"id" ,
"score"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_query_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"entries" ,
"knowledge_base_id" ,
"knowledge_base_query_id" ,
"query"
] ,
"type" : "object"
} Properties QueryRetrieverRequestContent {
"properties" : {
"query" : {
"type" : "string"
} ,
"retriever_components_query_args" : { }
} ,
"required" : [
"query"
] ,
"type" : "object"
} Properties QueryRetrieverResponseContent {
"properties" : {
"outputs" : {
"items" : { } ,
"type" : "array"
}
} ,
"required" : [
"outputs"
] ,
"type" : "object"
} Properties RespondToInviteRequestContent {
"properties" : {
"response" : {
"enum" : [
"ACCEPTED" ,
"REJECTED"
] ,
"type" : "string"
}
} ,
"required" : [
"response"
] ,
"type" : "object"
} Properties RetrieverComponentDetail {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties {
"properties" : {
"config" : { } ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"type"
] ,
"type" : "object"
} Properties RetrieverDetail {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"retriever_components_schema" : { } ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_components" ,
"retriever_components_schema" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Properties RuleDetail {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule" : {
"type" : "string"
} ,
"rule_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule" ,
"rule_id" ,
"updated_at"
] ,
"type" : "object"
} Properties RulesetDetail {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"description" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule_ids" ,
"ruleset_id" ,
"updated_at"
] ,
"type" : "object"
} Properties RunCountGauge {
"properties" : {
"active_count" : {
"type" : "number"
} ,
"total_count" : {
"type" : "number"
}
} ,
"type" : "object"
} Properties RunDurationGauge {
"properties" : {
"activity_durations" : {
"items" : {
"properties" : {
"activity_type" : {
"type" : "string"
} ,
"seconds" : {
"type" : "number"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"total_seconds" : {
"type" : "number"
}
} ,
"type" : "object"
} Properties S3ConnectorDetail {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
} Properties {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"aws_secret_access_key" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"aws_secret_access_key" ,
"uris"
] ,
"type" : "object"
} Properties SearchKnowledgeBaseRequestContent {
"properties" : {
"query" : {
"type" : "string"
} ,
"query_args" : { }
} ,
"required" : [
"query"
] ,
"type" : "object"
} Properties SearchKnowledgeBaseResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"knowledge_base_search_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"query" : {
"type" : "string"
} ,
"result" : {
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"knowledge_base_search_id" ,
"query" ,
"result"
] ,
"type" : "object"
} Properties SecretDetail {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"secret_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"last_used" ,
"name" ,
"organization_id" ,
"secret_id" ,
"updated_at"
] ,
"type" : "object"
} Properties ServiceErrorResponseContent {
"properties" : {
"errors" : {
"items" : { } ,
"type" : "array"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"type"
] ,
"type" : "object"
} Properties SlackDetail {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
} Properties {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_name"
] ,
"type" : "object"
} Properties SpanDetail {
"properties" : {
"attributes" : { } ,
"end_time" : {
"format" : "date-time" ,
"type" : "string"
} ,
"events" : {
"properties" : {
"attributes" : { } ,
"name" : {
"type" : "string"
} ,
"timestamp" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"attributes" ,
"name" ,
"timestamp"
] ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"parent_id" : {
"type" : "string"
} ,
"span_id" : {
"type" : "string"
} ,
"start_time" : {
"format" : "date-time" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"UNSET" ,
"OK" ,
"ERROR"
] ,
"type" : "string"
} ,
"trace_id" : {
"type" : "string"
}
} ,
"required" : [
"attributes" ,
"end_time" ,
"events" ,
"name" ,
"span_id" ,
"start_time" ,
"status" ,
"trace_id"
] ,
"type" : "object"
} Properties SpanStatus {
"enum" : [
"UNSET" ,
"OK" ,
"ERROR"
] ,
"type" : "string"
} Properties Enumerated Values StreamMessageContent {
"properties" : {
"artifact" : {
"properties" : {
"id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"meta" : { } ,
"name" : {
"type" : "string"
} ,
"reference" : {
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"id" ,
"name" ,
"type" ,
"value"
] ,
"type" : "object"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"artifact" ,
"type"
] ,
"type" : "object"
} Properties StructureCode {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} Properties oneOf
xor
xor
StructureConnectorDetail {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
} Properties {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
} Properties StructureDeploymentDetail {
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status" ,
"structure_id"
] ,
"type" : "object"
} Properties StructureDetail {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Properties StructureRunDetail {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"args" ,
"completed_at" ,
"created_at" ,
"created_by" ,
"started_at" ,
"status" ,
"structure_id" ,
"structure_run_id" ,
"updated_at"
] ,
"type" : "object"
} Properties StructureRunStatus {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} Properties Enumerated Values StructuredColumnDetail {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} Properties {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} Properties ThreadDetail {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Properties TokenCountGauge {
"properties" : {
"by_model" : {
"additionalProperties" : {
"properties" : {
"input" : {
"format" : "float" ,
"type" : "number"
} ,
"output" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} ,
"type" : "object"
} ,
"input" : {
"format" : "float" ,
"type" : "number"
} ,
"output" : {
"format" : "float" ,
"type" : "number"
}
} ,
"type" : "object"
} Properties {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} Properties oneOf
xor
xor
{
"properties" : {
"code_source" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"commit_sha" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"status" : {
"enum" : [
"QUEUED" ,
"DEPLOYING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"code_source" ,
"created_at" ,
"created_by" ,
"deployment_id" ,
"status" ,
"tool_id"
] ,
"type" : "object"
} Properties {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_config_file" : {
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"tool_id" ,
"updated_at"
] ,
"type" : "object"
} Properties {
"properties" : {
"completed_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"input" : { } ,
"output" : { } ,
"output_timestamp" : {
"format" : "double" ,
"type" : "number"
} ,
"runtime_path" : {
"type" : "string"
} ,
"started_at" : {
"default" : null ,
"format" : "date-time" ,
"type" : "string" ,
"nullable" : true
} ,
"status" : {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} ,
"status_detail" : { } ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_run_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"completed_at" ,
"created_at" ,
"created_by" ,
"input" ,
"runtime_path" ,
"started_at" ,
"status" ,
"tool_id" ,
"tool_run_id" ,
"updated_at"
] ,
"type" : "object"
} Properties {
"enum" : [
"QUEUED" ,
"STARTING" ,
"RUNNING" ,
"SUCCEEDED" ,
"FAILED" ,
"ERROR" ,
"CANCELLED"
] ,
"type" : "string"
} Properties Enumerated Values {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} Properties {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"type" : "object"
} Properties UnstructuredColumnDetail {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} Properties {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} Properties UpdateApiKeyRequestContent {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateApiKeyResponseContent {
"properties" : {
"active" : {
"type" : "boolean"
} ,
"api_key_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"active" ,
"api_key_id" ,
"created_at" ,
"created_by" ,
"last_used" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateAssistantRequestContent {
"properties" : {
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties UpdateAssistantResponseContent {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"input" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"tool_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"description" ,
"knowledge_base_ids" ,
"name" ,
"organization_id" ,
"retriever_ids" ,
"ruleset_ids" ,
"structure_ids" ,
"tool_ids" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateBucketRequestContent {
"properties" : {
"name" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateBucketResponseContent {
"properties" : {
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"bucket_id" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateDataConnectorRequestContent {
"properties" : {
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_api_token" : {
"type" : "string"
} ,
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_api_token" ,
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"auth_code" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"auth_code" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"aws_secret_access_key" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"aws_secret_access_key" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateDataConnectorResponseContent {
"properties" : {
"config" : {
"oneOf" : [
{
"properties" : {
"confluence" : {
"properties" : {
"atlassian_email" : {
"type" : "string"
} ,
"domain" : {
"type" : "string"
}
} ,
"required" : [
"atlassian_email" ,
"domain"
] ,
"type" : "object"
}
} ,
"required" : [
"confluence"
] ,
"title" : "confluence" ,
"type" : "object"
} ,
{
"properties" : {
"google_drive" : {
"properties" : {
"access_token" : {
"type" : "string"
} ,
"file_ids" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"access_token" ,
"file_ids"
] ,
"type" : "object"
}
} ,
"required" : [
"google_drive"
] ,
"title" : "google_drive" ,
"type" : "object"
} ,
{
"properties" : {
"webscraper" : {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
}
} ,
"required" : [
"webscraper"
] ,
"title" : "webscraper" ,
"type" : "object"
} ,
{
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"required" : [
"structure"
] ,
"title" : "structure" ,
"type" : "object"
} ,
{
"properties" : {
"s3" : {
"properties" : {
"aws_access_key_id" : {
"type" : "string"
} ,
"uris" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"aws_access_key_id" ,
"uris"
] ,
"type" : "object"
}
} ,
"required" : [
"s3"
] ,
"title" : "s3" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"bucket_id" : {
"type" : "string"
}
} ,
"required" : [
"asset_paths" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"data_job_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"data_connector_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateFunctionRequestContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateFunctionResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"function_config_file" : {
"type" : "string"
} ,
"function_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"function_id" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateIntegrationRequestContent {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_name"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateIntegrationResponseContent {
"properties" : {
"assistant_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"slack" : {
"properties" : {
"app_description" : {
"type" : "string"
} ,
"app_display_name" : {
"type" : "string"
} ,
"app_manifest" : { } ,
"app_name" : {
"type" : "string"
} ,
"bot_token_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"signing_secret_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_description" ,
"app_display_name" ,
"app_manifest" ,
"app_name" ,
"bot_token_secret_ref" ,
"signing_secret_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"slack"
] ,
"title" : "slack" ,
"type" : "object"
} ,
{
"properties" : {
"github_app" : {
"properties" : {
"app_id" : {
"type" : "string"
} ,
"integration_endpoint" : {
"type" : "string"
} ,
"private_key_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"webhook_secret_ref" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"app_id" ,
"integration_endpoint" ,
"private_key_secret_ref" ,
"webhook_secret_ref"
] ,
"type" : "object"
}
} ,
"required" : [
"github_app"
] ,
"title" : "github_app" ,
"type" : "object"
} ,
{
"properties" : {
"webhook" : {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
}
} ,
"required" : [
"webhook"
] ,
"title" : "webhook" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"integration_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"type" : {
"enum" : [
"slack" ,
"github_app" ,
"webhook"
] ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_ids" ,
"config" ,
"created_at" ,
"created_by" ,
"description" ,
"integration_id" ,
"name" ,
"organization_id" ,
"structure_ids" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateKnowledgeBaseRequestContent {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"password"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"structured_columns" ,
"unstructured_columns"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"config" ,
"type"
] ,
"type" : "object"
} Properties UpdateKnowledgeBaseResponseContent {
"properties" : {
"asset_paths" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"config" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"query_schema" : { } ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
}
} ,
"required" : [
"column_name"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"embedding_model" ,
"query_schema" ,
"structured_columns" ,
"unstructured_columns" ,
"use_default_embedding_model"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"properties" : {
"knowledge_base_name" : {
"type" : "string"
} ,
"query_schema" : { }
} ,
"required" : [
"knowledge_base_name" ,
"query_schema"
] ,
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"embedding_model" : {
"enum" : [
"text-embedding-ada-002" ,
"text-embedding-3-small"
] ,
"type" : "string"
} ,
"knowledge_base_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"schedule_expression" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"transforms" : {
"items" : {
"properties" : {
"structure" : {
"properties" : {
"args" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
} ,
"structure_id" : {
"type" : "string"
}
} ,
"required" : [
"structure_id"
] ,
"type" : "object"
}
} ,
"type" : "object"
} ,
"type" : "array"
} ,
"type" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"asset_paths" ,
"config" ,
"created_at" ,
"created_by" ,
"knowledge_base_id" ,
"name" ,
"organization_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateLibraryRequestContent {
"properties" : {
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"knowledge_base_configs" : {
"items" : {
"oneOf" : [
{
"properties" : {
"pg_vector" : {
"properties" : {
"connection_string" : {
"type" : "string"
} ,
"embedding_model" : {
"type" : "string"
} ,
"password" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"connection_string" ,
"password"
] ,
"type" : "object"
}
} ,
"required" : [
"pg_vector"
] ,
"title" : "pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"type" : "object"
}
} ,
"required" : [
"gtc_pg_vector"
] ,
"title" : "gtc_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"gtc_hybrid_sql_pg_vector" : {
"properties" : {
"embedding_model" : {
"type" : "string"
} ,
"structured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"sql_type" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description" ,
"sql_type"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"unstructured_columns" : {
"items" : {
"properties" : {
"column_name" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
}
} ,
"required" : [
"column_name" ,
"description"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"use_default_embedding_model" : {
"type" : "boolean"
}
} ,
"required" : [
"structured_columns" ,
"unstructured_columns"
] ,
"type" : "object"
}
} ,
"required" : [
"gtc_hybrid_sql_pg_vector"
] ,
"title" : "gtc_hybrid_sql_pg_vector" ,
"type" : "object"
} ,
{
"properties" : {
"pgai_knowledge_base" : {
"type" : "object"
}
} ,
"required" : [
"pgai_knowledge_base"
] ,
"title" : "pgai_knowledge_base" ,
"type" : "object"
}
]
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"data_connector_ids" ,
"knowledge_base_configs" ,
"name"
] ,
"type" : "object"
} Properties UpdateLibraryResponseContent {
"properties" : {
"assistant_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"data_connector_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"description" : {
"type" : "string"
} ,
"knowledge_base_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"library_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"assistant_id" ,
"created_at" ,
"created_by" ,
"data_connector_ids" ,
"knowledge_base_ids" ,
"library_id" ,
"name" ,
"organization_id" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateMessageRequestContent {
"properties" : {
"input" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateMessageResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"index" : {
"type" : "number"
} ,
"input" : {
"type" : "string"
} ,
"message_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"index" ,
"input" ,
"message_id" ,
"metadata" ,
"output" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateOrganizationRequestContent {
"properties" : {
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateOrganizationResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"default_bucket_id" : {
"type" : "string"
} ,
"description" : {
"maxLength" : 2000 ,
"type" : "string"
} ,
"entitlement" : {
"allOf" : [
{
"enum" : [
"FREE" ,
"PAID" ,
"PARTNER" ,
"UNPAID" ,
"EXPIRED"
] ,
"type" : "string"
} ,
{
"default" : "FREE"
}
]
} ,
"model_config" : {
"properties" : {
"default_chat_model" : {
"type" : "string"
} ,
"default_embedding_model" : {
"type" : "string"
} ,
"default_image_generation_model" : {
"type" : "string"
} ,
"default_rerank_model" : {
"type" : "string"
}
} ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"default_bucket_id" ,
"description" ,
"entitlement" ,
"name" ,
"organization_id" ,
"updated_at"
] ,
"type" : "object"
} Properties allOf
and
continued
UpdateRetrieverComponentRequestContent {
"properties" : {
"config" : { } ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"config" ,
"type"
] ,
"type" : "object"
} Properties UpdateRetrieverComponentResponseContent {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateRetrieverRequestContent {
"properties" : {
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"retriever_component_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"description" : {
"maxLength" : 256 ,
"minLength" : 1 ,
"type" : "string"
} ,
"name" : {
"maxLength" : 64 ,
"minLength" : 1 ,
"type" : "string"
} ,
"type" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"type"
] ,
"type" : "object"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties UpdateRetrieverResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_components" : {
"items" : {
"properties" : {
"config" : { } ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"retriever_component_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : {
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"config" ,
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_component_id" ,
"type" ,
"updated_at"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"retriever_components_schema" : { } ,
"retriever_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"name" ,
"organization_id" ,
"retriever_components" ,
"retriever_components_schema" ,
"retriever_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateRuleRequestContent {
"properties" : {
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"rule" : {
"maxLength" : 2000 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateRuleResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule" : {
"type" : "string"
} ,
"rule_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule" ,
"rule_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateRulesetRequestContent {
"properties" : {
"alias" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
}
} ,
"type" : "object"
} Properties UpdateRulesetResponseContent {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"rule_ids" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"ruleset_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"description" ,
"metadata" ,
"name" ,
"organization_id" ,
"rule_ids" ,
"ruleset_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateSecretRequestContent {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"value" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateSecretResponseContent {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"last_used" : {
"format" : "date-time" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"secret_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"last_used" ,
"name" ,
"organization_id" ,
"secret_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateStructureRequestContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"structure_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Properties UpdateStructureResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"structure_config_file" : {
"type" : "string"
} ,
"structure_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"webhook_enabled" : {
"type" : "boolean"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"structure_id" ,
"updated_at" ,
"webhook_enabled"
] ,
"type" : "object"
} Properties UpdateThreadRequestContent {
"properties" : {
"alias" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"messages" : {
"items" : {
"properties" : {
"input" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"output" : {
"type" : "string"
}
} ,
"required" : [
"input" ,
"output"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateThreadResponseContent {
"properties" : {
"alias" : {
"type" : "string"
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"metadata" : {
"additionalProperties" : { } ,
"type" : "object"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"thread_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"alias" ,
"created_at" ,
"created_by" ,
"metadata" ,
"name" ,
"organization_id" ,
"thread_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UpdateToolRequestContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"description" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tool_config_file" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"type" : "object"
} Properties UpdateToolResponseContent {
"properties" : {
"code" : {
"oneOf" : [
{
"properties" : {
"github" : {
"properties" : {
"name" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"owner" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"push" : {
"properties" : {
"branch" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
} ,
"tag" : {
"maxLength" : 200 ,
"minLength" : 1 ,
"type" : "string"
}
} ,
"required" : [
"branch"
] ,
"type" : "object"
}
} ,
"required" : [
"name" ,
"owner" ,
"push"
] ,
"type" : "object"
}
} ,
"required" : [
"github"
] ,
"title" : "github" ,
"type" : "object"
} ,
{
"properties" : {
"data_lake" : {
"properties" : {
"asset_path" : {
"type" : "string"
} ,
"bucket_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"asset_path" ,
"bucket_id"
] ,
"type" : "object"
}
} ,
"required" : [
"data_lake"
] ,
"title" : "data_lake" ,
"type" : "object"
} ,
{
"properties" : {
"default" : {
"type" : "object"
}
} ,
"required" : [
"default"
] ,
"title" : "default" ,
"type" : "object"
}
]
} ,
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"created_by" : {
"type" : "string"
} ,
"description" : {
"type" : "string"
} ,
"env_vars" : {
"items" : {
"properties" : {
"name" : {
"type" : "string"
} ,
"source" : {
"enum" : [
"secret_ref" ,
"manual"
] ,
"type" : "string"
} ,
"value" : {
"type" : "string"
}
} ,
"required" : [
"name" ,
"value"
] ,
"type" : "object"
} ,
"type" : "array"
} ,
"latest_deployment_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organization_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"tool_config_file" : {
"type" : "string"
} ,
"tool_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
}
} ,
"required" : [
"code" ,
"created_at" ,
"created_by" ,
"description" ,
"env_vars" ,
"latest_deployment_id" ,
"name" ,
"organization_id" ,
"tool_id" ,
"updated_at"
] ,
"type" : "object"
} Properties UserDetail {
"properties" : {
"created_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"email" : {
"type" : "string"
} ,
"name" : {
"type" : "string"
} ,
"organizations" : {
"items" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
} ,
"type" : "array"
} ,
"updated_at" : {
"format" : "date-time" ,
"type" : "string"
} ,
"user_id" : {
"pattern" : "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$" ,
"type" : "string"
}
} ,
"required" : [
"created_at" ,
"email" ,
"organizations" ,
"updated_at" ,
"user_id"
] ,
"type" : "object"
} Properties WebhookDetail {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
} ,
"integration_endpoint" : {
"type" : "string"
}
} ,
"required" : [
"disable_api_key_param" ,
"integration_endpoint"
] ,
"type" : "object"
} Properties {
"properties" : {
"disable_api_key_param" : {
"type" : "boolean"
}
} ,
"type" : "object"
} Properties WebscraperDetail {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
} Properties {
"properties" : {
"urls" : {
"items" : {
"type" : "string"
} ,
"type" : "array"
}
} ,
"required" : [
"urls"
] ,
"type" : "object"
} Properties