Gen AI Builder v2023-09-19 ========================== Authentication -------------- - HTTP Authentication, scheme: Bearer HTTP Bearer authentication Default ------- ListUsers ^^^^^^^^^ ``GET /users`` **Example responses** .. code:: json { "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 ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListUsers 200 response,:ref:`ListUsersResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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 ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable api_key_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-1: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteApiKey 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-1: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable api_key_id,path,string,true,none **Example responses** .. code:: json { "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-2: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetApiKey 200 response,:ref:`GetApiKeyResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _parameters-2: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable api_key_id,path,string,true,none body,body,:ref:`UpdateApiKeyRequestContent` ,false,none **Example responses** .. code:: json { "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-3: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateApiKey 200 response,:ref:`UpdateApiKeyResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-3: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-4: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListOrganizationApiKeys 200 response,:ref:`ListOrganizationApiKeysResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _parameters-4: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,none body,body,:ref:`CreateOrganizationApiKeyRequestContent` ,true,none **Example responses** .. code:: json { "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-5: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateOrganizationApiKey 201 response,:ref:`CreateOrganizationApiKeyResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-5: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable user_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-6: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListApiKeys 200 response,:ref:`ListApiKeysResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _parameters-6: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable user_id,path,string,true,none body,body,:ref:`CreateApiKeyRequestContent` ,true,none **Example responses** .. code:: json { "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-7: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateApiKey 201 response,:ref:`CreateApiKeyResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-7: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_run_id,path,string,true,none **Example responses** .. code:: json { "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-8: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetAssistantRun 200 response,:ref:`GetAssistantRunResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-8: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_run_id,path,string,true,none **Example responses** .. code:: json { "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-9: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CancelAssistantRun 200 response,:ref:`CancelAssistantRunResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-9: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none status,query,array[string],false,Comma-separated list of run statuses to filter by. Enumerated Values ''''''''''''''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,STARTING status,RUNNING status,SUCCEEDED status,FAILED status,ERROR status,CANCELLED **Example responses** .. code:: json { "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-10: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListAssistantRuns 200 response,:ref:`ListAssistantRunsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-10: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_id,path,string,true,none body,body,:ref:`CreateAssistantRunRequestContent` ,false,none **Example responses** .. code:: json { "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-11: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateAssistantRun 201 response,:ref:`CreateAssistantRunResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-11: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_run_id,path,string,true,none limit,query,string,false,none offset,query,string,false,none **Example responses** .. code:: json { "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-12: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListAssistantEvents 200 response,:ref:`ListAssistantEventsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-12: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_run_id,path,string,true,none **Example responses** 400 Response .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-13: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetAssistantRunEventsSSE 200 response,:ref:`GetAssistantRunEventsSSEOutputPayload` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-13: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable event_id,path,string,true,none **Example responses** .. code:: json { "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-14: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetEvent 200 response,:ref:`GetEventResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-14: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,none limit,query,string,false,none offset,query,string,false,none **Example responses** .. code:: json { "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-15: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListEvents 200 response,:ref:`ListEventsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-15: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,none body,body,:ref:`CreateEventsRequestContent` ,false,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-16: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateEvents 202 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-16: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,none **Example responses** 400 Response .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-17: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetStructureRunEventsSSE 200 response,:ref:`GetStructureRunEventsSSEOutputPayload` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-17: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-18: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListAssistants 200 response,:ref:`ListAssistantsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-18: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateAssistantRequestContent` ,true,none **Example responses** .. code:: json { "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-19: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateAssistant 201 response,:ref:`CreateAssistantResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-19: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-20: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteAssistant 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-20: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_id,path,string,true,none **Example responses** .. code:: json { "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-21: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetAssistant 200 response,:ref:`GetAssistantResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-21: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_id,path,string,true,none body,body,:ref:`UpdateAssistantRequestContent` ,false,none **Example responses** .. code:: json { "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-22: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateAssistant 200 response,:ref:`UpdateAssistantResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "price_lookup_key": { "type": "string" } }, "required": [ "price_lookup_key" ], "type": "object" } .. _parameters-22: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateCheckoutSessionRequestContent` ,true,none **Example responses** .. code:: json { "properties": { "redirect_url": { "type": "string" } }, "required": [ "redirect_url" ], "type": "object" } .. _responses-23: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateCheckoutSession 201 response,:ref:`CreateCheckoutSessionResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "billing_management_url": { "type": "string" } }, "required": [ "billing_management_url" ], "type": "object" } .. _responses-24: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateBillingManagementUrl 201 response,:ref:`CreateBillingManagementUrlResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-23: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-25: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListBuckets 200 response,:ref:`ListBucketsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _parameters-24: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateBucketRequestContent` ,true,none **Example responses** .. code:: json { "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-26: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateBucket 201 response,:ref:`CreateBucketResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-25: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable bucket_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-27: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteBucket 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-26: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable bucket_id,path,string,true,none **Example responses** .. code:: json { "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-28: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetBucket 200 response,:ref:`GetBucketResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" } .. _parameters-27: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable bucket_id,path,string,true,none body,body,:ref:`UpdateBucketRequestContent` ,false,none **Example responses** .. code:: json { "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-29: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateBucket 200 response,:ref:`UpdateBucketResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "operation": { "enum": [ "PUT", "GET" ], "type": "string" } }, "type": "object" } .. _parameters-28: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable name,path,string,true,none bucket_id,path,string,true,none body,body,:ref:`CreateAssetUrlRequestContent` ,false,none **Example responses** .. code:: json { "properties": { "headers": { "additionalProperties": {}, "type": "object" }, "url": { "type": "string" } }, "required": [ "headers", "url" ], "type": "object" } .. _responses-30: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CreateAssetUrl 200 response,:ref:`CreateAssetUrlResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-29: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable bucket_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none prefix,query,string,false,none postfix,query,string,false,none **Example responses** .. code:: json { "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-31: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListAssets 200 response,:ref:`ListAssetsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _parameters-30: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable bucket_id,path,string,true,none body,body,:ref:`CreateAssetRequestContent` ,true,none **Example responses** .. code:: json { "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-32: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateAsset 201 response,:ref:`CreateAssetResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-31: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable name,path,string,true,none bucket_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-33: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteAsset 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-32: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable name,path,string,true,none bucket_id,path,string,true,none include_contents,query,boolean,false,true/false to include contents for the asset. **Example responses** .. code:: json { "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-34: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetAsset 200 response,:ref:`GetAssetResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-33: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateChatMessageRequestContent` ,true,none **Example responses** .. code:: json { "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-35: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateChatMessage 201 response,:ref:`CreateChatMessageResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-34: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateChatMessageStreamRequestContent` ,true,none **Example responses** .. code:: json { "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-36: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateChatMessageStream 201 response,:ref:`CreateChatMessageStreamResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-37: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetConfig 200 response,:ref:`GetConfigResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-35: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none type,query,string,false,none **Example responses** .. code:: json { "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-38: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListConnections 200 response,:ref:`ListConnectionsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-36: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateConnectionRequestContent` ,true,none **Example responses** .. code:: json { "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-39: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateConnection 201 response,:ref:`CreateConnectionResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-37: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable connection_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-40: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteConnection 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-38: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable connection_id,path,string,true,none **Example responses** .. code:: json { "properties": { "access_token": { "type": "string" } }, "required": [ "access_token" ], "type": "object" } .. _responses-41: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetToken 200 response,:ref:`GetTokenResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-39: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable start_time,query,string(date-time),false,none end_time,query,string(date-time),false,none period,query,:ref:`Period` ,false,none structure_ids,query,string,false,none .. _enumerated-values-1: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable period,1m period,1h period,1d period,1w **Example responses** .. code:: json { "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-42: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetStructuresDashboard 200 response,:ref:`GetStructuresDashboardResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth ListStructures ^^^^^^^^^^^^^^ ``GET /structures`` .. _parameters-40: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-43: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListStructures 200 response,:ref:`ListStructuresResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-41: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateStructureRequestContent` ,true,none **Example responses** .. code:: json { "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-44: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateStructure 201 response,:ref:`CreateStructureResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-42: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-45: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteStructure 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-43: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,none **Example responses** .. code:: json { "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-46: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetStructure 200 response,:ref:`GetStructureResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-44: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,none body,body,:ref:`UpdateStructureRequestContent` ,false,none **Example responses** .. code:: json { "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-47: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateStructure 200 response,:ref:`UpdateStructureResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-45: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,none api_key,query,string,false,none **Example responses** .. code:: json { "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-48: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,InvokeStructureWebhookGet 200 response,:ref:`InvokeStructureWebhookGetResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-46: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,none api_key,query,string,false,none **Example responses** .. code:: json { "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-49: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,InvokeStructureWebhookPost 200 response,:ref:`InvokeStructureWebhookPostResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-47: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-50: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListDataConnectors 200 response,:ref:`ListDataConnectorsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-48: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateDataConnectorRequestContent` ,true,none **Example responses** .. code:: json { "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-51: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateDataConnector 201 response,:ref:`CreateDataConnectorResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-49: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_connector_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-52: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteDataConnector 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-50: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_connector_id,path,string,true,none **Example responses** .. code:: json { "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-53: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetDataConnector 200 response,:ref:`GetDataConnectorResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-51: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_connector_id,path,string,true,none body,body,:ref:`UpdateDataConnectorRequestContent` ,false,none **Example responses** .. code:: json { "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-54: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateDataConnector 200 response,:ref:`UpdateDataConnectorResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-52: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_connector_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none status,query,array[string],false,Comma-separated list of statuses to filter by. .. _enumerated-values-2: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,RUNNING status,SUCCEEDED status,FAILED status,CANCELLED **Example responses** .. code:: json { "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-55: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListDataJobs 200 response,:ref:`ListDataJobsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-53: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_connector_id,path,string,true,none **Example responses** .. code:: json { "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-56: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateDataJob 202 response,:ref:`CreateDataJobResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-54: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_job_id,path,string,true,none **Example responses** .. code:: json { "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-57: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetDataJob 200 response,:ref:`GetDataJobResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-55: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_job_id,path,string,true,none **Example responses** .. code:: json { "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-58: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CancelDataJob 200 response,:ref:`CancelDataJobResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-56: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable deployment_id,path,string,true,none **Example responses** .. code:: json { "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-59: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetDeployment 200 response,:ref:`GetDeploymentResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-57: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-60: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListFunctionDeployments 200 response,:ref:`ListFunctionDeploymentsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-58: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,none body,body,:ref:`CreateFunctionDeploymentRequestContent` ,false,none **Example responses** .. code:: json { "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-61: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateFunctionDeployment 202 response,:ref:`CreateFunctionDeploymentResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-59: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none status,query,array[string],false,Comma-separated list of deployment statuses to filter by. .. _enumerated-values-3: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,DEPLOYING status,SUCCEEDED status,FAILED status,ERROR **Example responses** .. code:: json { "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-62: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListStructureDeployments 200 response,:ref:`ListStructureDeploymentsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-60: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,none body,body,:ref:`CreateStructureDeploymentRequestContent` ,false,none **Example responses** .. code:: json { "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-63: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateStructureDeployment 202 response,:ref:`CreateStructureDeploymentResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth ListToolDeployments ^^^^^^^^^^^^^^^^^^^ ``GET /tools/{tool_id}/deployments`` .. _parameters-61: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-64: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListToolDeployments 200 response,:ref:`ListToolDeploymentsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth CreateToolDeployment ^^^^^^^^^^^^^^^^^^^^ ``POST /tools/{tool_id}/deployments`` **Body parameter** .. code:: json { "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-62: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,none body,body,:ref:`CreateToolDeploymentRequestContent` ,false,none **Example responses** .. code:: json { "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-65: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateToolDeployment 202 response,:ref:`CreateToolDeploymentResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-63: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_run_id,path,string,true,none **Example responses** .. code:: json { "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-66: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetFunctionRun 200 response,:ref:`GetFunctionRunResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-64: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_run_id,path,string,true,none **Example responses** .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _responses-67: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListFunctionRunLogs 200 response,:ref:`ListFunctionRunLogsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-65: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none status,query,array[string],false,Comma-separated list of run statuses to filter by. .. _enumerated-values-4: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,STARTING status,RUNNING status,SUCCEEDED status,FAILED status,ERROR status,CANCELLED **Example responses** .. code:: json { "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-68: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListFunctionRuns 200 response,:ref:`ListFunctionRunsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-66: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-69: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListFunctions 200 response,:ref:`ListFunctionsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-67: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateFunctionRequestContent` ,true,none **Example responses** .. code:: json { "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-70: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateFunction 201 response,:ref:`CreateFunctionResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-68: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-71: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteFunction 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-69: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,none **Example responses** .. code:: json { "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-72: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetFunction 200 response,:ref:`GetFunctionResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-70: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,none body,body,:ref:`UpdateFunctionRequestContent` ,false,none **Example responses** .. code:: json { "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-73: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateFunction 200 response,:ref:`UpdateFunctionResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-71: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,none **Example responses** .. code:: json {} .. _responses-74: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CreateFunctionExecutionGet 200 response,:ref:`CreateFunctionExecutionGetOutputPayload` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json {} .. _parameters-72: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,none body,body,:ref:`CreateFunctionExecutionPostInputPayload` ,false,none **Example responses** .. code:: json {} .. _responses-75: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CreateFunctionExecutionPost 200 response,:ref:`CreateFunctionExecutionPostOutputPayload` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-73: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-76: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListIntegrations 200 response,:ref:`ListIntegrationsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-74: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateIntegrationRequestContent` ,true,none **Example responses** .. code:: json { "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-77: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateIntegration 201 response,:ref:`CreateIntegrationResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-75: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable integration_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-78: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteIntegration 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-76: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable integration_id,path,string,true,none **Example responses** .. code:: json { "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-79: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetIntegration 200 response,:ref:`GetIntegrationResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-77: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable integration_id,path,string,true,none body,body,:ref:`UpdateIntegrationRequestContent` ,false,none **Example responses** .. code:: json { "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-80: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateIntegration 200 response,:ref:`UpdateIntegrationResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-78: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-81: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListUserInvites 200 response,:ref:`ListUserInvitesResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-79: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable invite_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-82: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteInvite 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-80: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable invite_id,path,string,true,none **Example responses** .. code:: json { "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-83: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetInvite 200 response,:ref:`GetInviteResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "response": { "enum": [ "ACCEPTED", "REJECTED" ], "type": "string" } }, "required": [ "response" ], "type": "object" } .. _parameters-81: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable invite_id,path,string,true,none body,body,:ref:`RespondToInviteRequestContent` ,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-84: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,RespondToInvite 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-82: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-85: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListInvites 200 response,:ref:`ListInvitesResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "email": { "maxLength": 254, "minLength": 1, "type": "string" } }, "required": [ "email" ], "type": "object" } .. _parameters-83: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,none body,body,:ref:`CreateInviteRequestContent` ,true,none **Example responses** .. code:: json { "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-86: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateInvite 201 response,:ref:`CreateInviteResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-84: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_job_id,path,string,true,none **Example responses** .. code:: json { "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-87: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetKnowledgeBaseJob 200 response,:ref:`GetKnowledgeBaseJobResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-85: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_job_id,path,string,true,none **Example responses** .. code:: json { "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-88: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CancelKnowledgeBaseJob 200 response,:ref:`CancelKnowledgeBaseJobResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-86: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none status,query,array[string],false,Comma-separated list of statuses to filter by. .. _enumerated-values-5: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,RUNNING status,SUCCEEDED status,FAILED status,CANCELLED **Example responses** .. code:: json { "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-89: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListKnowledgeBaseJobs 200 response,:ref:`ListKnowledgeBaseJobsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-87: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,none **Example responses** .. code:: json { "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-90: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateKnowledgeBaseJob 202 response,:ref:`CreateKnowledgeBaseJobResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-88: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_query_id,path,string,true,none **Example responses** .. code:: json { "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-91: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetKnowledgeBaseQuery 200 response,:ref:`GetKnowledgeBaseQueryResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-89: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_search_id,path,string,true,none **Example responses** .. code:: json { "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-92: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetKnowledgeBaseSearch 200 response,:ref:`GetKnowledgeBaseSearchResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-90: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-93: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListKnowledgeBases 200 response,:ref:`ListKnowledgeBasesResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-91: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateKnowledgeBaseRequestContent` ,true,none **Example responses** .. code:: json { "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-94: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateKnowledgeBase 201 response,:ref:`CreateKnowledgeBaseResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-92: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-95: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteKnowledgeBase 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-93: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,none **Example responses** .. code:: json { "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-96: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetKnowledgeBase 200 response,:ref:`GetKnowledgeBaseResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-94: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,none body,body,:ref:`UpdateKnowledgeBaseRequestContent` ,true,none **Example responses** .. code:: json { "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-97: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateKnowledgeBase 200 response,:ref:`UpdateKnowledgeBaseResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-95: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-98: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListKnowledgeBaseQueries 200 response,:ref:`ListKnowledgeBaseQueriesResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "query": { "type": "string" }, "query_args": {} }, "type": "object" } .. _parameters-96: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,none body,body,:ref:`QueryKnowledgeBaseRequestContent` ,false,none **Example responses** .. code:: json { "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-99: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,QueryKnowledgeBase 200 response,:ref:`QueryKnowledgeBaseResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "query": { "type": "string" }, "query_args": {} }, "required": [ "query" ], "type": "object" } .. _parameters-97: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,none body,body,:ref:`SearchKnowledgeBaseRequestContent` ,true,none **Example responses** .. code:: json { "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-100: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,SearchKnowledgeBase 200 response,:ref:`SearchKnowledgeBaseResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-98: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-101: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListKnowledgeBaseSearches 200 response,:ref:`ListKnowledgeBaseSearchesResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-99: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-102: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListLibraries 200 response,:ref:`ListLibrariesResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-100: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateLibraryRequestContent` ,true,none **Example responses** .. code:: json { "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-103: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateLibrary 201 response,:ref:`CreateLibraryResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-101: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable library_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-104: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteLibrary 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-102: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable library_id,path,string,true,none **Example responses** .. code:: json { "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-105: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetLibrary 200 response,:ref:`GetLibraryResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-103: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable library_id,path,string,true,none body,body,:ref:`UpdateLibraryRequestContent` ,true,none **Example responses** .. code:: json { "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-106: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateLibrary 200 response,:ref:`UpdateLibraryResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-104: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable message_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-107: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteMessage 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-105: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable message_id,path,string,true,none **Example responses** .. code:: json { "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-108: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetMessage 200 response,:ref:`GetMessageResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "type": "object" } .. _parameters-106: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable message_id,path,string,true,none body,body,:ref:`UpdateMessageRequestContent` ,false,none **Example responses** .. code:: json { "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-109: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateMessage 200 response,:ref:`UpdateMessageResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-107: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable thread_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-110: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListMessages 200 response,:ref:`ListMessagesResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "required": [ "input", "output" ], "type": "object" } .. _parameters-108: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable thread_id,path,string,true,none body,body,:ref:`CreateMessageRequestContent` ,true,none **Example responses** .. code:: json { "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-111: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateMessage 201 response,:ref:`CreateMessageResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-109: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none model_type,query,string,false,none default,query,boolean,false,none **Example responses** .. code:: json { "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-112: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListModels 200 response,:ref:`ListModelsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-113: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListOrganizations 200 response,:ref:`ListOrganizationsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "description": { "maxLength": 2000, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _parameters-110: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateOrganizationRequestContent` ,true,none **Example responses** .. code:: json { "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-114: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateOrganization 201 response,:ref:`CreateOrganizationResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-111: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-115: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteOrganization 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-112: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,none **Example responses** .. code:: json { "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-116: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetOrganization 200 response,:ref:`GetOrganizationResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-113: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,none body,body,:ref:`UpdateOrganizationRequestContent` ,false,none **Example responses** .. code:: json { "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-117: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateOrganization 200 response,:ref:`UpdateOrganizationResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-114: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-118: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListOrganizationUsers 200 response,:ref:`ListOrganizationUsersResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-115: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,none user_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-119: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteOrganizationUser 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-116: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-120: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListRetrieverComponents 200 response,:ref:`ListRetrieverComponentsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-117: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateRetrieverComponentRequestContent` ,true,none **Example responses** .. code:: json { "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-121: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateRetrieverComponent 201 response,:ref:`CreateRetrieverComponentResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-118: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_component_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-122: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteRetrieverComponent 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-119: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_component_id,path,string,true,none **Example responses** .. code:: json { "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-123: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetRetrieverComponent 200 response,:ref:`GetRetrieverComponentResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-120: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_component_id,path,string,true,none body,body,:ref:`UpdateRetrieverComponentRequestContent` ,true,none **Example responses** .. code:: json { "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-124: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateRetrieverComponent 200 response,:ref:`UpdateRetrieverComponentResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-121: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-125: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListRetrievers 200 response,:ref:`ListRetrieversResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-122: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateRetrieverRequestContent` ,true,none **Example responses** .. code:: json { "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-126: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateRetriever 201 response,:ref:`CreateRetrieverResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-123: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-127: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteRetriever 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-124: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_id,path,string,true,none **Example responses** .. code:: json { "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-128: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetRetriever 200 response,:ref:`GetRetrieverResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-125: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_id,path,string,true,none body,body,:ref:`UpdateRetrieverRequestContent` ,false,none **Example responses** .. code:: json { "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-129: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateRetriever 200 response,:ref:`UpdateRetrieverResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "query": { "type": "string" }, "retriever_components_query_args": {} }, "required": [ "query" ], "type": "object" } .. _parameters-126: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_id,path,string,true,none body,body,:ref:`QueryRetrieverRequestContent` ,true,none **Example responses** .. code:: json { "properties": { "outputs": { "items": {}, "type": "array" } }, "required": [ "outputs" ], "type": "object" } .. _responses-130: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,QueryRetriever 200 response,:ref:`QueryRetrieverResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-127: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none ruleset_id,query,string,false,none **Example responses** .. code:: json { "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-131: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListRules 200 response,:ref:`ListRulesResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-128: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateRuleRequestContent` ,true,none **Example responses** .. code:: json { "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-132: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateRule 201 response,:ref:`CreateRuleResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-129: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable rule_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-133: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteRule 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-130: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable rule_id,path,string,true,none **Example responses** .. code:: json { "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-134: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetRule 200 response,:ref:`GetRuleResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "rule": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "type": "object" } .. _parameters-131: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable rule_id,path,string,true,none body,body,:ref:`UpdateRuleRequestContent` ,false,none **Example responses** .. code:: json { "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-135: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateRule 200 response,:ref:`UpdateRuleResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-132: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none alias,query,string,false,none **Example responses** .. code:: json { "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-136: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListRulesets 200 response,:ref:`ListRulesetsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-133: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateRulesetRequestContent` ,true,none **Example responses** .. code:: json { "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-137: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateRuleset 201 response,:ref:`CreateRulesetResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-134: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable ruleset_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-138: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteRuleset 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-135: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable ruleset_id,path,string,true,none **Example responses** .. code:: json { "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-139: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetRuleset 200 response,:ref:`GetRulesetResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-136: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable ruleset_id,path,string,true,none body,body,:ref:`UpdateRulesetRequestContent` ,false,none **Example responses** .. code:: json { "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-140: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateRuleset 200 response,:ref:`UpdateRulesetResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-137: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-141: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListSecrets 200 response,:ref:`ListSecretsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "value": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" } .. _parameters-138: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateSecretRequestContent` ,true,none **Example responses** .. code:: json { "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-142: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateSecret 201 response,:ref:`CreateSecretResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-139: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable secret_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-143: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteSecret 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-140: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable secret_id,path,string,true,none **Example responses** .. code:: json { "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-144: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetSecret 200 response,:ref:`GetSecretResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "value": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _parameters-141: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable secret_id,path,string,true,none body,body,:ref:`UpdateSecretRequestContent` ,false,none **Example responses** .. code:: json { "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-145: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateSecret 200 response,:ref:`UpdateSecretResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-142: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,none **Example responses** .. code:: json { "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-146: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetStructureRun 200 response,:ref:`GetStructureRunResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-143: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,none **Example responses** .. code:: json { "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-147: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CancelStructureRun 200 response,:ref:`CancelStructureRunResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-144: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,none **Example responses** .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _responses-148: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListStructureRunLogs 200 response,:ref:`ListStructureRunLogsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-145: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none status,query,array[string],false,Comma-separated list of run statuses to filter by. .. _enumerated-values-6: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,STARTING status,RUNNING status,SUCCEEDED status,FAILED status,ERROR status,CANCELLED **Example responses** .. code:: json { "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-149: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListStructureRuns 200 response,:ref:`ListStructureRunsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-146: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,none body,body,:ref:`CreateStructureRunRequestContent` ,true,none **Example responses** .. code:: json { "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-150: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateStructureRun 201 response,:ref:`CreateStructureRunResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-147: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-151: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListSpans 200 response,:ref:`ListSpansResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-148: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none alias,query,string,false,none **Example responses** .. code:: json { "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-152: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListThreads 200 response,:ref:`ListThreadsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-149: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateThreadRequestContent` ,true,none **Example responses** .. code:: json { "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-153: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateThread 201 response,:ref:`CreateThreadResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-150: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable thread_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-154: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteThread 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-151: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable thread_id,path,string,true,none **Example responses** .. code:: json { "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-155: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetThread 200 response,:ref:`GetThreadResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-152: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable thread_id,path,string,true,none body,body,:ref:`UpdateThreadRequestContent` ,false,none **Example responses** .. code:: json { "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-156: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateThread 200 response,:ref:`UpdateThreadResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth ToolRuns -------- GetToolRun ^^^^^^^^^^ ``GET /tool-runs/{tool_run_id}`` .. _parameters-153: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_run_id,path,string,true,none **Example responses** .. code:: json { "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-157: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetToolRun 200 response,:ref:`GetToolRunResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth ListToolRunLogs ^^^^^^^^^^^^^^^ ``GET /tool-runs/{tool_run_id}/logs`` .. _parameters-154: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_run_id,path,string,true,none **Example responses** .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _responses-158: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListToolRunLogs 200 response,:ref:`ListToolRunLogsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth ListToolRuns ^^^^^^^^^^^^ ``GET /tools/{tool_id}/runs`` .. _parameters-155: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,none page,query,number,false,none page_size,query,number,false,none status,query,array[string],false,Comma-separated list of run statuses to filter by. .. _enumerated-values-7: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,STARTING status,RUNNING status,SUCCEEDED status,FAILED status,ERROR status,CANCELLED **Example responses** .. code:: json { "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-159: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListToolRuns 200 response,:ref:`ListToolRunsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth Tools ----- ListTools ^^^^^^^^^ ``GET /tools`` .. _parameters-156: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,none page_size,query,number,false,none **Example responses** .. code:: json { "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-160: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListTools 200 response,:ref:`ListToolsResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth CreateTool ^^^^^^^^^^ ``POST /tools`` **Body parameter** .. code:: json { "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-157: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateToolRequestContent` ,true,none **Example responses** .. code:: json { "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-161: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateTool 201 response,:ref:`CreateToolResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth DeleteTool ^^^^^^^^^^ ``DELETE /tools/{tool_id}`` .. _parameters-158: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,none **Example responses** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _responses-162: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteTool 204 response,None 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth GetTool ^^^^^^^ ``GET /tools/{tool_id}`` .. _parameters-159: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,none **Example responses** .. code:: json { "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-163: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetTool 200 response,:ref:`GetToolResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth UpdateTool ^^^^^^^^^^ ``PATCH /tools/{tool_id}`` **Body parameter** .. code:: json { "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-160: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,none body,body,:ref:`UpdateToolRequestContent` ,false,none **Example responses** .. code:: json { "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-164: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateTool 200 response,:ref:`UpdateToolResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth ToolInvoke ---------- CreateToolActivityRun ^^^^^^^^^^^^^^^^^^^^^ ``POST /tools/{tool_id}/activities/{activity_path}`` **Body parameter** .. code:: json {} .. _parameters-161: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,none activity_path,path,string,true,none body,body,:ref:`CreateToolActivityRunInputPayload` ,false,none **Example responses** .. code:: json {} .. _responses-165: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CreateToolActivityRun 200 response,:ref:`CreateToolActivityRunOutputPayload` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth GetToolOpenApiRun ^^^^^^^^^^^^^^^^^ ``GET /tools/{tool_id}/openapi`` .. _parameters-162: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,none **Example responses** .. code:: json {} .. _responses-166: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetToolOpenApiRun 200 response,:ref:`GetToolOpenApiRunOutputPayload` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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** .. code:: json { "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-167: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetUsage 200 response,:ref:`GetUsageResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. 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-163: Parameters ^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable user_id,path,string,true,none **Example responses** .. code:: json { "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-168: Responses ^^^^^^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetUser 200 response,:ref:`GetUserResponseContent` 400, `Bad Request `__ ,ClientError 400 response,:ref:`ClientErrorResponseContent` 500, `Internal Server Error `__ ,ServiceError 500 response,:ref:`ServiceErrorResponseContent` .. warning:: To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth Schemas ------- ActivityDuration ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "activity_type": { "type": "string" }, "seconds": { "type": "number" } }, "type": "object" } Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable activity_type,string,false,none,none seconds,number,false,none,none ApiKeyDetail ^^^^^^^^^^^^ .. code:: json { "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-1: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active,boolean,true,none,none api_key_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none last_used,string(date-time),true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none Artifact ^^^^^^^^ .. code:: json { "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-2: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable id,string,true,none,none meta,any,false,none,none name,string,true,none,none reference,string,false,none,none type,string,true,none,none value,string,true,none,none AssertUrlOperation ^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "PUT", "GET" ], "type": "string" } .. _properties-3: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-8: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,PUT *anonymous*,GET AssetDetail ^^^^^^^^^^^ .. code:: json { "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-4: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,false,none,none contents,any,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none name,string,true,none,none organization_id,string,true,none,none size,number,false,none,none updated_at,string(date-time),true,none,none AssistantDetail ^^^^^^^^^^^^^^^ .. code:: json { "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-5: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none input,string,false,none,none knowledge_base_ids,[string],true,none,none name,string,true,none,none organization_id,string,true,none,none retriever_ids,[string],true,none,none ruleset_ids,[string],true,none,none structure_ids,[string],true,none,none tool_ids,[string],true,none,none updated_at,string(date-time),true,none,none AssistantEventDetail ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-6: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_run_id,string,true,none,none created_at,string(date-time),true,none,none event_id,string,true,none,none origin,string,true,none,none payload,any,true,none,none timestamp,number(double),true,none,none type,string,true,none,none AssistantRunDetail ^^^^^^^^^^^^^^^^^^ .. code:: json { "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-7: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,none assistant_id,string,true,none,none assistant_run_id,string,true,none,none completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none input,string,false,none,none knowledge_base_ids,[string],true,none,none output,any,false,none,none retriever_ids,[string],true,none,none ruleset_ids,[string],true,none,none status,:ref:`AssistantRunStatus` ,true,none,none status_detail,any,false,none,none stream,boolean,true,none,none structure_ids,[string],true,none,none thread_id,string,false,none,none tool_ids,[string],true,none,none updated_at,string(date-time),true,none,none AssistantRunStatus ^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" } .. _properties-8: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-9: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,STARTING *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,ERROR *anonymous*,CANCELLED BucketDetail ^^^^^^^^^^^^ .. code:: json { "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-9: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none CancelAssistantRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-10: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,none assistant_id,string,true,none,none assistant_run_id,string,true,none,none completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none input,string,false,none,none knowledge_base_ids,[string],true,none,none output,any,false,none,none retriever_ids,[string],true,none,none ruleset_ids,[string],true,none,none status,:ref:`AssistantRunStatus` ,true,none,none status_detail,any,false,none,none stream,boolean,true,none,none structure_ids,[string],true,none,none thread_id,string,false,none,none tool_ids,[string],true,none,none updated_at,string(date-time),true,none,none CancelDataJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-11: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_id,string,true,none,none data_job_id,string,true,none,none errors,\ :ref:`[Error <.#tocs_error>` ],false,none,none status,:ref:`DataJobStatus` ,true,none,none status_detail,any,false,none,none CancelKnowledgeBaseJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-12: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none errors,\ :ref:`[Error <.#tocs_error>` ],false,none,none knowledge_base_id,string,true,none,none knowledge_base_job_id,string,true,none,none status,:ref:`KnowledgeBaseJobStatus` ,true,none,none status_detail,any,false,none,none CancelStructureRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-13: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,none completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none output,any,false,none,none output_timestamp,number(double),false,none,none started_at,string(date-time)¦null,true,none,none status,:ref:`StructureRunStatus` ,true,none,none status_detail,any,false,none,none structure_id,string,true,none,none structure_run_id,string,true,none,none updated_at,string(date-time),true,none,none ChatMessageDriverConfiguration ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-14: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable extra_params,any,false,none,none max_tokens,number,false,none,none model,string,false,none,none structured_output_strategy,string,false,none,none temperature,number(float),false,none,none use_native_tools,boolean,false,none,none ChatMessageMessage ^^^^^^^^^^^^^^^^^^ .. code:: json { "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-15: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable content,\ :ref:`[MessageContent <.#tocs_messagecontent>` ],true,none,none role,string,true,none,none usage,:ref:`ChatMessageUsage` ,true,none,none ChatMessageTool ^^^^^^^^^^^^^^^ .. code:: json { "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-16: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable activities,\ :ref:`[ChatMessageToolActivity <.#tocs_chatmessagetoolactivity>` ],true,none,none name,string,true,none,none ChatMessageToolActivity ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-17: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,true,none,none json_schema,:ref:`JsonSchema` ,true,none,none name,string,true,none,none ChatMessageUsage ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } .. _properties-18: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable input_tokens,number,true,none,none output_tokens,number,true,none,none type,string,true,none,none ClientErrorResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _properties-19: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable errors,[any],false,none,none type,string,true,none,none CodeSource ^^^^^^^^^^ .. code:: json { "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-20: Properties ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » github,:ref:`GithubCodeSource` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » data_lake,:ref:`DataLakeCodeSource` ,true,none,none CodeSourceInput ^^^^^^^^^^^^^^^ .. code:: json { "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-21: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable github,:ref:`GithubCodeSourceInput` ,true,none,none ConfluenceDetail ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } .. _properties-22: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable atlassian_email,string,true,none,none domain,string,true,none,none ConfluenceInput ^^^^^^^^^^^^^^^ .. code:: json { "properties": { "atlassian_api_token": { "type": "string" }, "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_api_token", "atlassian_email", "domain" ], "type": "object" } .. _properties-23: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable atlassian_api_token,string,true,none,none atlassian_email,string,true,none,none domain,string,true,none,none ConnectionCredentialsInput ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "github": { "properties": { "auth_code": { "type": "string" } }, "required": [ "auth_code" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] } .. _properties-24: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable github,:ref:`GitHubCredentialsInput` ,true,none,none ConnectionDetail ^^^^^^^^^^^^^^^^ .. code:: json { "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-25: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable connection_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none name,string,true,none,none type,string,true,none,none updated_at,string(date-time),true,none,none CreateApiKeyRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _properties-26: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,none CreateApiKeyResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-27: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active,boolean,true,none,none api_key_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none last_used,string(date-time),true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none value,string,true,none,none CreateAssetRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _properties-28: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,none CreateAssetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-29: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,false,none,none contents,any,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none name,string,true,none,none organization_id,string,true,none,none size,number,false,none,none updated_at,string(date-time),true,none,none CreateAssetUrlRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "operation": { "enum": [ "PUT", "GET" ], "type": "string" } }, "type": "object" } .. _properties-30: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable operation,:ref:`AssertUrlOperation` ,false,none,none CreateAssetUrlResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "headers": { "additionalProperties": {}, "type": "object" }, "url": { "type": "string" } }, "required": [ "headers", "url" ], "type": "object" } .. _properties-31: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable headers,:ref:`Metadata` ,true,none,none url,string,true,none,none CreateAssistantRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-32: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,false,none,none input,string,false,none,none knowledge_base_ids,[string],false,none,none name,string,true,none,none retriever_ids,[string],false,none,none ruleset_ids,[string],false,none,none structure_ids,[string],false,none,none tool_ids,[string],false,none,none CreateAssistantResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-33: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none input,string,false,none,none knowledge_base_ids,[string],true,none,none name,string,true,none,none organization_id,string,true,none,none retriever_ids,[string],true,none,none ruleset_ids,[string],true,none,none structure_ids,[string],true,none,none tool_ids,[string],true,none,none updated_at,string(date-time),true,none,none CreateAssistantRunRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-34: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable additional_knowledge_base_ids,[string],false,none,none additional_retriever_ids,[string],false,none,none additional_ruleset_ids,[string],false,none,none additional_structure_ids,[string],false,none,none additional_tool_ids,[string],false,none,none args,[string],false,none,none input,string,false,none,none knowledge_base_ids,[string],false,none,none new_thread,boolean,false,none,"If true, create a new thread for this run to be returned in the response thread_id." retriever_ids,[string],false,none,none ruleset_ids,[string],false,none,none stream,boolean,false,none,none structure_ids,[string],false,none,none thread_id,string,false,none,"If provided, the run will be associated with the given thread. This takes precedence over new_thread." tool_ids,[string],false,none,none CreateAssistantRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-35: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,none assistant_id,string,true,none,none assistant_run_id,string,true,none,none completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none input,string,false,none,none knowledge_base_ids,[string],true,none,none output,any,false,none,none retriever_ids,[string],true,none,none ruleset_ids,[string],true,none,none status,:ref:`AssistantRunStatus` ,true,none,none status_detail,any,false,none,none stream,boolean,true,none,none structure_ids,[string],true,none,none thread_id,string,false,none,none tool_ids,[string],true,none,none updated_at,string(date-time),true,none,none CreateBillingManagementUrlResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "billing_management_url": { "type": "string" } }, "required": [ "billing_management_url" ], "type": "object" } .. _properties-36: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable billing_management_url,string,true,none,none CreateBucketRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _properties-37: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,none CreateBucketResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-38: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none CreateChatMessageRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-39: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable driver_configuration,:ref:`ChatMessageDriverConfiguration` ,true,none,none messages,\ :ref:`[ChatMessageMessage <.#tocs_chatmessagemessage>` ],true,none,none output_schema,:ref:`JsonSchema` ,true,none,none tools,\ :ref:`[ChatMessageTool <.#tocs_chatmessagetool>` ],true,none,none CreateChatMessageResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-40: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable content,\ :ref:`[MessageContent <.#tocs_messagecontent>` ],true,none,none role,string,true,none,none type,string,true,none,none usage,:ref:`ChatMessageUsage` ,true,none,none CreateChatMessageStreamRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-41: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable driver_configuration,:ref:`ChatMessageDriverConfiguration` ,true,none,none messages,\ :ref:`[ChatMessageMessage <.#tocs_chatmessagemessage>` ],true,none,none output_schema,:ref:`JsonSchema` ,true,none,none tools,\ :ref:`[ChatMessageTool <.#tocs_chatmessagetool>` ],true,none,none CreateChatMessageStreamResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-42: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable content,\ :ref:`[StreamMessageContent <.#tocs_streammessagecontent>` ],true,none,none role,string,true,none,none type,string,true,none,none usage,:ref:`ChatMessageUsage` ,false,none,none CreateCheckoutSessionRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "price_lookup_key": { "type": "string" } }, "required": [ "price_lookup_key" ], "type": "object" } .. _properties-43: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable price_lookup_key,string,true,none,none CreateCheckoutSessionResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "redirect_url": { "type": "string" } }, "required": [ "redirect_url" ], "type": "object" } .. _properties-44: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable redirect_url,string,true,none,none CreateConnectionRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-45: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable credentials,:ref:`ConnectionCredentialsInput` ,true,none,none name,string,false,none,none type,string,true,none,none CreateConnectionResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-46: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable connection_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none name,string,true,none,none type,string,true,none,none CreateDataConnectorRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-47: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,:ref:`DataConnectorConfigInputUnion` ,true,none,none description,string,false,none,none name,string,true,none,none schedule_expression,string,false,none,none transforms,\ :ref:`[TransformInput <.#tocs_transforminput>` ],false,none,none type,string,true,none,none CreateDataConnectorResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-48: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,:ref:`DataConnectorConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_id,string,true,none,none data_job_id,string,false,none,none description,string,false,none,none name,string,true,none,none schedule_expression,string,false,none,none type,string,true,none,none updated_at,string(date-time),true,none,none CreateDataJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-49: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_id,string,true,none,none data_job_id,string,true,none,none errors,\ :ref:`[Error <.#tocs_error>` ],false,none,none status,:ref:`DataJobStatus` ,true,none,none status_detail,any,false,none,none CreateEventsRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-50: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable events,\ :ref:`[EventInput <.#tocs_eventinput>` ],false,none,none CreateFunctionDeploymentRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-51: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`CodeSourceInput` ,false,none,none force,boolean,false,none,none CreateFunctionDeploymentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-52: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`CodeSource` ,true,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,true,none,none function_id,string,true,none,none status,:ref:`DeploymentStatus` ,true,none,none status_detail,any,false,none,none CreateFunctionExecutionGetOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _properties-53: Properties ^^^^^^^^^^ - None\* CreateFunctionExecutionPostInputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _properties-54: Properties ^^^^^^^^^^ - None\* CreateFunctionExecutionPostOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _properties-55: Properties ^^^^^^^^^^ - None\* CreateFunctionRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-56: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeFunctionCode` ,false,none,none description,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none function_config_file,string,false,none,none name,string,true,none,none CreateFunctionResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-57: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeFunctionCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none function_config_file,string,false,none,none function_id,string,true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none CreateIntegrationRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-58: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],false,none,none config,:ref:`IntegrationConfigInputUnion` ,true,none,none description,string,false,none,none name,string,true,none,none structure_ids,[string],false,none,none type,:ref:`IntegrationType` ,true,none,none CreateIntegrationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-59: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],true,none,none config,:ref:`IntegrationConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none integration_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none structure_ids,[string],true,none,none type,:ref:`IntegrationType` ,true,none,none updated_at,string(date-time),true,none,none CreateInviteRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "email": { "maxLength": 254, "minLength": 1, "type": "string" } }, "required": [ "email" ], "type": "object" } .. _properties-60: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable email,string,true,none,none CreateInviteResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-61: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none email,string,true,none,none expires_at,string(date-time),true,none,none invite_id,string,true,none,none organization_id,string,true,none,none responded_at,string(date-time),false,none,none status,:ref:`InviteStatus` ,true,none,none CreateKnowledgeBaseJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-62: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none errors,\ :ref:`[Error <.#tocs_error>` ],false,none,none knowledge_base_id,string,true,none,none knowledge_base_job_id,string,true,none,none status,:ref:`KnowledgeBaseJobStatus` ,true,none,none status_detail,any,false,none,none CreateKnowledgeBaseRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-63: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],false,none,none config,:ref:`KnowledgeBaseConfigInputUnion` ,true,none,none description,string,false,none,none embedding_model,:ref:`EmbeddingModel` ,false,none,none name,string,true,none,none transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,none type,string,true,none,none use_default_embedding_model,boolean,false,none,none CreateKnowledgeBaseResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-64: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],true,none,none config,:ref:`KnowledgeBaseConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none embedding_model,:ref:`EmbeddingModel` ,false,none,none knowledge_base_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none schedule_expression,string,false,none,none transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,none type,string,true,none,none updated_at,string(date-time),true,none,none use_default_embedding_model,boolean,false,none,none CreateLibraryRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-65: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable data_connector_ids,[string],true,none,none description,string,false,none,none knowledge_base_configs,\ :ref:`[KnowledgeBaseConfigInputUnion <.#tocs_knowledgebaseconfiginputunion>` ],true,none,none name,string,true,none,none CreateLibraryResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-66: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_ids,[string],true,none,none description,string,false,none,none knowledge_base_ids,[string],true,none,none library_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none retriever_id,string,true,none,none updated_at,string(date-time),true,none,none CreateMessageRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "required": [ "input", "output" ], "type": "object" } .. _properties-67: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable input,string,true,none,none metadata,:ref:`Metadata` ,false,none,none output,string,true,none,none CreateMessageResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-68: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none index,number,true,none,none input,string,true,none,none message_id,string,true,none,none metadata,:ref:`Metadata` ,true,none,none output,string,true,none,none thread_id,string,true,none,none updated_at,string(date-time),true,none,none CreateOrganizationApiKeyRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _properties-69: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,none CreateOrganizationApiKeyResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-70: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active,boolean,true,none,none api_key_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none last_used,string(date-time),true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none value,string,true,none,none CreateOrganizationRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "description": { "maxLength": 2000, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _properties-71: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,false,none,none name,string,true,none,none CreateOrganizationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-72: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none default_bucket_id,string,true,none,none description,string,true,none,none entitlement,any,true,none,none allOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,:ref:`Entitlement` ,false,none,none and .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,any,false,none,none continued .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable model_config,:ref:`OrganizationModelConfig` ,false,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none CreateRetrieverComponentRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-73: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,none description,string,false,none,none name,string,true,none,none type,string,true,none,none CreateRetrieverComponentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-74: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none retriever_component_id,string,true,none,none type,string,true,none,none updated_at,string(date-time),true,none,none CreateRetrieverRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-75: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,false,none,none name,string,true,none,none retriever_component_ids,[string],false,none,none retriever_components,\ :ref:`[RetrieverComponentInput <.#tocs_retrievercomponentinput>` ],false,none,none CreateRetrieverResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-76: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none retriever_components,\ :ref:`[RetrieverComponentDetail <.#tocs_retrievercomponentdetail>` ],true,none,none retriever_components_schema,any,true,none,none retriever_id,string,true,none,none updated_at,string(date-time),true,none,none CreateRuleRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-77: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable metadata,:ref:`Metadata` ,false,none,none name,string,true,none,none rule,string,true,none,none CreateRuleResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-78: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none rule,string,true,none,none rule_id,string,true,none,none updated_at,string(date-time),true,none,none CreateRulesetRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-79: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,false,none,none description,string,false,none,none metadata,:ref:`Metadata` ,false,none,none name,string,true,none,none rule_ids,[string],false,none,none CreateRulesetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-80: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none rule_ids,[string],true,none,none ruleset_id,string,true,none,none updated_at,string(date-time),true,none,none CreateSecretRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "value": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" } .. _properties-81: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,none value,string,true,none,none CreateSecretResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-82: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none last_used,string(date-time),true,none,none name,string,true,none,none organization_id,string,true,none,none secret_id,string,true,none,none updated_at,string(date-time),true,none,none CreateStructureDeploymentRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-83: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`CodeSourceInput` ,false,none,none force,boolean,false,none,none CreateStructureDeploymentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-84: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`CodeSource` ,true,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,true,none,none status,:ref:`DeploymentStatus` ,true,none,none status_detail,any,false,none,none structure_id,string,true,none,none CreateStructureRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-85: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,false,none,none description,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none name,string,true,none,none structure_config_file,string,false,none,none webhook_enabled,boolean,false,none,none CreateStructureResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-86: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none structure_config_file,string,false,none,none structure_id,string,true,none,none updated_at,string(date-time),true,none,none webhook_enabled,boolean,true,none,none CreateStructureRunRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-87: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none CreateStructureRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-88: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,none completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none output,any,false,none,none output_timestamp,number(double),false,none,none started_at,string(date-time)¦null,true,none,none status,:ref:`StructureRunStatus` ,true,none,none status_detail,any,false,none,none structure_id,string,true,none,none structure_run_id,string,true,none,none updated_at,string(date-time),true,none,none CreateThreadRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-89: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,false,none,none messages,\ :ref:`[MessageInput <.#tocs_messageinput>` ],false,none,none metadata,:ref:`Metadata` ,false,none,none name,string,true,none,none CreateThreadResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-90: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none thread_id,string,true,none,none updated_at,string(date-time),true,none,none CreateToolActivityRunInputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _properties-91: Properties ^^^^^^^^^^ - None\* CreateToolActivityRunOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _properties-92: Properties ^^^^^^^^^^ - None\* CreateToolDeploymentRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-93: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`CodeSourceInput` ,false,none,none force,boolean,false,none,none CreateToolDeploymentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-94: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`CodeSource` ,true,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,true,none,none status,:ref:`DeploymentStatus` ,true,none,none status_detail,any,false,none,none tool_id,string,true,none,none CreateToolRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-95: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,false,none,none description,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none name,string,true,none,none tool_config_file,string,false,none,none CreateToolResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-96: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none tool_config_file,string,false,none,none tool_id,string,true,none,none updated_at,string(date-time),true,none,none DataConnectorConfigInputUnion ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-97: Properties ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » confluence,:ref:`ConfluenceInput` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » google_drive,:ref:`GoogleDriveInput` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » webscraper,:ref:`WebscraperInput` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » structure,:ref:`StructureConnectorInput` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » s3,:ref:`S3ConnectorInput` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » data_lake,:ref:`DataLakeConnectorInput` ,true,none,none DataConnectorConfigUnion ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-98: Properties ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » confluence,:ref:`ConfluenceDetail` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » google_drive,:ref:`GoogleDriveDetail` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » webscraper,:ref:`WebscraperDetail` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » structure,:ref:`StructureConnectorDetail` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » s3,:ref:`S3ConnectorDetail` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » data_lake,:ref:`DataLakeConnectorDetail` ,true,none,none DataConnectorDetail ^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-99: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,false,none,none config,:ref:`DataConnectorConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_id,string,true,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none schedule_expression,string,false,none,none transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,none type,string,true,none,none updated_at,string(date-time),true,none,none DataJobDetail ^^^^^^^^^^^^^ .. code:: json { "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-100: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_id,string,true,none,none data_job_id,string,true,none,none errors,\ :ref:`[Error <.#tocs_error>` ],false,none,none status,:ref:`DataJobStatus` ,true,none,none status_detail,any,false,none,none DataJobStatus ^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" } .. _properties-101: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-10: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,CANCELLED DataLakeCodeSource ^^^^^^^^^^^^^^^^^^ .. code:: json { "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-102: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_path,string,true,none,none bucket_id,string,true,none,none DataLakeConnectorDetail ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } .. _properties-103: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],true,none,none bucket_id,string,true,none,none DataLakeConnectorInput ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "bucket_id" ], "type": "object" } .. _properties-104: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],false,none,none bucket_id,string,true,none,none DataLakeFunctionCode ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-105: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_path,string,true,none,none bucket_id,string,true,none,none DataLakeStructureCode ^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-106: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_path,string,true,none,none bucket_id,string,true,none,none DataLakeToolCode ^^^^^^^^^^^^^^^^ .. code:: json { "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-107: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_path,string,true,none,none bucket_id,string,true,none,none DefaultFunctionCode ^^^^^^^^^^^^^^^^^^^ .. code:: json { "type": "object" } .. _properties-108: Properties ^^^^^^^^^^ - None\* DefaultStructureCode ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "type": "object" } .. _properties-109: Properties ^^^^^^^^^^ - None\* DefaultToolCode ^^^^^^^^^^^^^^^ .. code:: json { "type": "object" } .. _properties-110: Properties ^^^^^^^^^^ - None\* DeploymentCountGauge ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "active_count": { "type": "number" }, "total_count": { "type": "number" } }, "type": "object" } .. _properties-111: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active_count,number,false,none,none total_count,number,false,none,none DeploymentDurationGauge ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "total_seconds": { "type": "number" } }, "type": "object" } .. _properties-112: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable total_seconds,number,false,none,none DeploymentErrorRateGauge ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "rate": { "format": "float", "type": "number" } }, "type": "object" } .. _properties-113: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable rate,number(float),false,none,none DeploymentStatus ^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" } .. _properties-114: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-11: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,DEPLOYING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,ERROR DurationPlot ^^^^^^^^^^^^ .. code:: json { "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-115: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable seconds_avg,number,false,none,none seconds_p100,number,false,none,none seconds_p50,number,false,none,none timeseries,\ :ref:`[DurationTimeseriesElement <.#tocs_durationtimeserieselement>` ],false,none,none DurationTimeseriesElement ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "seconds_p0": { "type": "number" }, "seconds_p100": { "type": "number" }, "seconds_p50": { "type": "number" }, "time": { "format": "date-time", "type": "string" } }, "type": "object" } .. _properties-116: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable seconds_p0,number,false,none,none seconds_p100,number,false,none,none seconds_p50,number,false,none,none time,string(date-time),false,none,none EmbeddingModel ^^^^^^^^^^^^^^ .. code:: json { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" } .. _properties-117: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-12: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,text-embedding-ada-002 *anonymous*,text-embedding-3-small Entitlement ^^^^^^^^^^^ .. code:: json { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" } .. _properties-118: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-13: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,FREE *anonymous*,PAID *anonymous*,PARTNER *anonymous*,UNPAID *anonymous*,EXPIRED Entry ^^^^^ .. code:: json { "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-119: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable id,string,true,none,none meta,:ref:`Meta` ,false,none,none namespace,string,false,none,none score,number(float),true,none,none vector,[number],false,none,none EnvVar ^^^^^^ .. code:: json { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" } .. _properties-120: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,none source,:ref:`EnvVarSource` ,false,none,none value,string,true,none,none EnvVarSource ^^^^^^^^^^^^ .. code:: json { "enum": [ "secret_ref", "manual" ], "type": "string" } .. _properties-121: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-14: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,secret_ref *anonymous*,manual Error ^^^^^ .. code:: json { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" } .. _properties-122: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable message,string,true,none,none path,string,false,none,none type,string,true,none,none ErrorRateGauge ^^^^^^^^^^^^^^ .. code:: json { "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-123: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable error_type_counts,\ :ref:`[ErrorTypeCount <.#tocs_errortypecount>` ],false,none,none rate,number(float),false,none,none ErrorTypeCount ^^^^^^^^^^^^^^ .. code:: json { "properties": { "count": { "type": "number" }, "error_type": { "type": "string" } }, "type": "object" } .. _properties-124: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable count,number,false,none,none error_type,string,false,none,none EventDetail ^^^^^^^^^^^ .. code:: json { "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-125: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none event_id,string,true,none,none origin,string,true,none,none payload,any,true,none,none structure_run_id,string,true,none,none timestamp,number(double),true,none,none type,string,true,none,none EventInput ^^^^^^^^^^ .. code:: json { "properties": { "payload": {}, "timestamp": { "format": "double", "type": "number" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "timestamp", "type" ], "type": "object" } .. _properties-126: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable payload,any,false,none,none timestamp,number(double),true,none,none type,string,true,none,none FunctionCode ^^^^^^^^^^^^ .. code:: json { "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-127: Properties ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » github,:ref:`GithubFunctionCode` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » data_lake,:ref:`DataLakeFunctionCode` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » default,:ref:`DefaultFunctionCode` ,true,none,none FunctionDeploymentDetail ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-128: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`CodeSource` ,true,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,true,none,none function_id,string,true,none,none status,:ref:`DeploymentStatus` ,true,none,none status_detail,any,false,none,none FunctionDetail ^^^^^^^^^^^^^^ .. code:: json { "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-129: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeFunctionCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none function_config_file,string,false,none,none function_id,string,true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none FunctionRunDetail ^^^^^^^^^^^^^^^^^ .. code:: json { "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-130: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none function_id,string,true,none,none function_run_id,string,true,none,none input,any,true,none,none output,any,false,none,none output_timestamp,number(double),false,none,none runtime_path,string,true,none,none started_at,string(date-time)¦null,true,none,none status,:ref:`FunctionRunStatus` ,true,none,none status_detail,any,false,none,none updated_at,string(date-time),true,none,none FunctionRunStatus ^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" } .. _properties-131: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-15: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,STARTING *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,ERROR *anonymous*,CANCELLED GTCHybidSQLPGVectorKnowledgeBaseDetail ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-132: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable embedding_model,string,true,none,none query_schema,any,true,none,none structured_columns,\ :ref:`[StructuredColumnDetail <.#tocs_structuredcolumndetail>` ],true,none,none unstructured_columns,\ :ref:`[UnstructuredColumnDetail <.#tocs_unstructuredcolumndetail>` ],true,none,none use_default_embedding_model,boolean,true,none,none GTCHybidSQLPGVectorKnowledgeBaseInput ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-133: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable embedding_model,string,false,none,none structured_columns,\ :ref:`[StructuredColumnInput <.#tocs_structuredcolumninput>` ],true,none,none unstructured_columns,\ :ref:`[UnstructuredColumnInput <.#tocs_unstructuredcolumninput>` ],true,none,none use_default_embedding_model,boolean,false,none,none GTCPGVectorKnowledgeBaseDetail ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-134: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable embedding_model,string,true,none,none query_schema,any,true,none,none use_default_embedding_model,boolean,true,none,none GTCPGVectorKnowledgeBaseInput ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } .. _properties-135: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable embedding_model,string,false,none,none use_default_embedding_model,boolean,false,none,none GetApiKeyResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-136: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active,boolean,true,none,none api_key_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none last_used,string(date-time),true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none GetAssetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-137: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,false,none,none contents,any,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none name,string,true,none,none organization_id,string,true,none,none size,number,false,none,none updated_at,string(date-time),true,none,none GetAssistantResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-138: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none input,string,false,none,none knowledge_base_ids,[string],true,none,none name,string,true,none,none organization_id,string,true,none,none retriever_ids,[string],true,none,none ruleset_ids,[string],true,none,none structure_ids,[string],true,none,none tool_ids,[string],true,none,none updated_at,string(date-time),true,none,none GetAssistantRunEventsSSEOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "format": "byte", "type": "string" } .. _properties-139: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string(byte),false,none,none GetAssistantRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-140: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,none assistant_id,string,true,none,none assistant_run_id,string,true,none,none completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none input,string,false,none,none knowledge_base_ids,[string],true,none,none output,any,false,none,none retriever_ids,[string],true,none,none ruleset_ids,[string],true,none,none status,:ref:`AssistantRunStatus` ,true,none,none status_detail,any,false,none,none stream,boolean,true,none,none structure_ids,[string],true,none,none thread_id,string,false,none,none tool_ids,[string],true,none,none updated_at,string(date-time),true,none,none GetBucketResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-141: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none GetConfigResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-142: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable data_lake_s3_bucket,string,true,none,none data_lake_s3_region,string,true,none,none data_lake_s3_url,string,true,none,none google_drive_data_connector_client_id,string,true,none,none GetDataConnectorResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-143: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,false,none,none config,:ref:`DataConnectorConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_id,string,true,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none schedule_expression,string,false,none,none transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,none type,string,true,none,none updated_at,string(date-time),true,none,none GetDataJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-144: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_id,string,true,none,none data_job_id,string,true,none,none errors,\ :ref:`[Error <.#tocs_error>` ],false,none,none status,:ref:`DataJobStatus` ,true,none,none status_detail,any,false,none,none GetDeploymentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-145: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`CodeSource` ,true,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,true,none,none function_id,string,false,none,none status,:ref:`DeploymentStatus` ,true,none,none status_detail,any,false,none,none structure_id,string,false,none,none tool_id,string,false,none,none GetEventResponseContent ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-146: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none event_id,string,true,none,none origin,string,true,none,none payload,any,true,none,none structure_run_id,string,true,none,none timestamp,number(double),true,none,none type,string,true,none,none GetFunctionResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-147: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeFunctionCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none function_config_file,string,false,none,none function_id,string,true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none GetFunctionRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-148: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none function_id,string,true,none,none function_run_id,string,true,none,none input,any,true,none,none output,any,false,none,none output_timestamp,number(double),false,none,none runtime_path,string,true,none,none started_at,string(date-time)¦null,true,none,none status,:ref:`FunctionRunStatus` ,true,none,none status_detail,any,false,none,none updated_at,string(date-time),true,none,none GetIntegrationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-149: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],true,none,none config,:ref:`IntegrationConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none integration_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none structure_ids,[string],true,none,none type,:ref:`IntegrationType` ,true,none,none updated_at,string(date-time),true,none,none GetInviteResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-150: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none email,string,true,none,none expires_at,string(date-time),true,none,none invite_id,string,true,none,none organization_id,string,true,none,none responded_at,string(date-time),false,none,none status,:ref:`InviteStatus` ,true,none,none GetKnowledgeBaseJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-151: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none errors,\ :ref:`[Error <.#tocs_error>` ],false,none,none knowledge_base_id,string,true,none,none knowledge_base_job_id,string,true,none,none status,:ref:`KnowledgeBaseJobStatus` ,true,none,none status_detail,any,false,none,none GetKnowledgeBaseQueryResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-152: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none entries,\ :ref:`[Entry <.#tocs_entry>` ],true,none,none knowledge_base_id,string,true,none,none knowledge_base_query_id,string,true,none,none query,string,true,none,none GetKnowledgeBaseResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-153: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],true,none,none config,:ref:`KnowledgeBaseConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none embedding_model,:ref:`EmbeddingModel` ,false,none,none knowledge_base_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none schedule_expression,string,false,none,none transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,none type,string,true,none,none updated_at,string(date-time),true,none,none use_default_embedding_model,boolean,false,none,none GetKnowledgeBaseSearchResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-154: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none knowledge_base_id,string,true,none,none knowledge_base_search_id,string,true,none,none query,string,true,none,none result,string,true,none,none GetLibraryResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-155: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_ids,[string],true,none,none description,string,false,none,none knowledge_base_ids,[string],true,none,none library_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none retriever_id,string,true,none,none updated_at,string(date-time),true,none,none GetMessageResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-156: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none index,number,true,none,none input,string,true,none,none message_id,string,true,none,none metadata,:ref:`Metadata` ,true,none,none output,string,true,none,none thread_id,string,true,none,none updated_at,string(date-time),true,none,none GetOrganizationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-157: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none default_bucket_id,string,true,none,none description,string,true,none,none entitlement,any,true,none,none allOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,:ref:`Entitlement` ,false,none,none and .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,any,false,none,none continued .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable model_config,:ref:`OrganizationModelConfig` ,false,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none GetRetrieverComponentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-158: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none retriever_component_id,string,true,none,none type,string,true,none,none updated_at,string(date-time),true,none,none GetRetrieverResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-159: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none retriever_components,\ :ref:`[RetrieverComponentDetail <.#tocs_retrievercomponentdetail>` ],true,none,none retriever_components_schema,any,true,none,none retriever_id,string,true,none,none updated_at,string(date-time),true,none,none GetRuleResponseContent ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-160: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none rule,string,true,none,none rule_id,string,true,none,none updated_at,string(date-time),true,none,none GetRulesetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-161: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none rule_ids,[string],true,none,none ruleset_id,string,true,none,none updated_at,string(date-time),true,none,none GetSecretResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-162: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none last_used,string(date-time),true,none,none name,string,true,none,none organization_id,string,true,none,none secret_id,string,true,none,none updated_at,string(date-time),true,none,none GetStructureResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-163: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none structure_config_file,string,false,none,none structure_id,string,true,none,none updated_at,string(date-time),true,none,none webhook_enabled,boolean,true,none,none GetStructureRunEventsSSEOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "format": "byte", "type": "string" } .. _properties-164: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string(byte),false,none,none GetStructureRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-165: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,none completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none output,any,false,none,none output_timestamp,number(double),false,none,none started_at,string(date-time)¦null,true,none,none status,:ref:`StructureRunStatus` ,true,none,none status_detail,any,false,none,none structure_id,string,true,none,none structure_run_id,string,true,none,none updated_at,string(date-time),true,none,none GetStructuresDashboardResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-166: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable deployment_count_gauge,:ref:`DeploymentCountGauge` ,false,none,none deployment_duration_gauge,:ref:`DeploymentDurationGauge` ,false,none,none deployment_error_rate_gauge,:ref:`DeploymentErrorRateGauge` ,false,none,none duration_plot,:ref:`DurationPlot` ,false,none,none error_rate_gauge,:ref:`DeploymentErrorRateGauge` ,false,none,none run_count_gauge,:ref:`RunCountGauge` ,false,none,none run_duration_gauge,:ref:`RunDurationGauge` ,false,none,none token_count_gauge,:ref:`TokenCountGauge` ,false,none,none GetThreadResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-167: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none thread_id,string,true,none,none updated_at,string(date-time),true,none,none GetTokenResponseContent ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "access_token": { "type": "string" } }, "required": [ "access_token" ], "type": "object" } .. _properties-168: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable access_token,string,true,none,none GetToolOpenApiRunOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _properties-169: Properties ^^^^^^^^^^ - None\* GetToolResponseContent ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-170: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none tool_config_file,string,false,none,none tool_id,string,true,none,none updated_at,string(date-time),true,none,none GetToolRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-171: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none input,any,true,none,none output,any,false,none,none output_timestamp,number(double),false,none,none runtime_path,string,true,none,none started_at,string(date-time)¦null,true,none,none status,:ref:`ToolRunStatus` ,true,none,none status_detail,any,false,none,none tool_id,string,true,none,none tool_run_id,string,true,none,none updated_at,string(date-time),true,none,none GetUsageResponseContent ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-172: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,true,none,none bytes_ingested_limit,number,true,none,none rag_queries,number,true,none,none rag_queries_limit,number,true,none,none runtime_seconds,number,true,none,none runtime_seconds_limit,number,true,none,none usage_period_end,string(date-time),true,none,none usage_period_start,string(date-time),true,none,none GetUserResponseContent ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-173: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none email,string,true,none,none name,string,false,none,none organizations,[string],true,none,none updated_at,string(date-time),true,none,none user_id,string,true,none,none GitHubAppDetail ^^^^^^^^^^^^^^^ .. code:: json { "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-174: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable app_id,string,true,none,none integration_endpoint,string,true,none,none private_key_secret_ref,string,true,none,none webhook_secret_ref,string,true,none,none GitHubAppInput ^^^^^^^^^^^^^^ .. code:: json { "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-175: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable app_id,string,false,none,none private_key_secret_ref,string,false,none,none webhook_secret_ref,string,false,none,none GitHubCredentialsInput ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "auth_code": { "type": "string" } }, "required": [ "auth_code" ], "type": "object" } .. _properties-176: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable auth_code,string,true,none,none GithubCodeSource ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _properties-177: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable commit_sha,string,false,none,none GithubCodeSourceInput ^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "access_token": { "maxLength": 1000, "minLength": 1, "type": "string" }, "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _properties-178: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable access_token,string,false,none,none commit_sha,string,false,none,none GithubFunctionCode ^^^^^^^^^^^^^^^^^^ .. code:: json { "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-179: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,none owner,string,true,none,none push,:ref:`GithubFunctionCodePushConfig` ,true,none,none GithubFunctionCodePushConfig ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } .. _properties-180: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable branch,string,true,none,none tag,string,false,none,none GithubStructureCode ^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-181: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,none owner,string,true,none,none push,:ref:`GithubStructureCodePushConfig` ,true,none,none GithubStructureCodePushConfig ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } .. _properties-182: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable branch,string,true,none,none tag,string,false,none,none GithubToolCode ^^^^^^^^^^^^^^ .. code:: json { "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-183: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,none owner,string,true,none,none push,:ref:`GithubToolCodePushConfig` ,true,none,none GithubToolCodePushConfig ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } .. _properties-184: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable branch,string,true,none,none tag,string,false,none,none GoogleDriveDetail ^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } .. _properties-185: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable access_token,string,true,none,none file_ids,[string],true,none,none GoogleDriveInput ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "auth_code": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "auth_code", "file_ids" ], "type": "object" } .. _properties-186: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable auth_code,string,true,none,none file_ids,[string],true,none,none IntegrationConfigInputUnion ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-187: Properties ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » slack,:ref:`SlackInput` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » github_app,:ref:`GitHubAppInput` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » webhook,:ref:`WebhookInput` ,true,none,none IntegrationConfigUnion ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-188: Properties ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » slack,:ref:`SlackDetail` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » github_app,:ref:`GitHubAppDetail` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » webhook,:ref:`WebhookDetail` ,true,none,none IntegrationDetail ^^^^^^^^^^^^^^^^^ .. code:: json { "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-189: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],true,none,none config,:ref:`IntegrationConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none integration_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none structure_ids,[string],true,none,none type,:ref:`IntegrationType` ,true,none,none updated_at,string(date-time),true,none,none IntegrationType ^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "slack", "github_app", "webhook" ], "type": "string" } .. _properties-190: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-16: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,slack *anonymous*,github_app *anonymous*,webhook InviteDetail ^^^^^^^^^^^^ .. code:: json { "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-191: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none email,string,true,none,none expires_at,string(date-time),true,none,none invite_id,string,true,none,none organization_id,string,true,none,none responded_at,string(date-time),false,none,none status,:ref:`InviteStatus` ,true,none,none InviteResponseStatus ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "ACCEPTED", "REJECTED" ], "type": "string" } .. _properties-192: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-17: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,ACCEPTED *anonymous*,REJECTED InviteStatus ^^^^^^^^^^^^ .. code:: json { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } .. _properties-193: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-18: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,ACCEPTED *anonymous*,EXPIRED *anonymous*,PENDING *anonymous*,REJECTED InvokeStructureWebhookGetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-194: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none structure_config_file,string,false,none,none structure_id,string,true,none,none updated_at,string(date-time),true,none,none webhook_enabled,boolean,true,none,none InvokeStructureWebhookPostResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-195: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none structure_config_file,string,false,none,none structure_id,string,true,none,none updated_at,string(date-time),true,none,none webhook_enabled,boolean,true,none,none JsonSchema ^^^^^^^^^^ .. code:: json { "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-196: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable additionalProperties,boolean,true,none,none description,string,true,none,none id,string,true,none,none properties,:ref:`JsonSchemaProperties` ,true,none,none required,[string],true,none,none schema,string,true,none,none title,string,true,none,none type,string,true,none,none JsonSchemaProperties ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-197: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable member,:ref:`JsonSchemaProperty` ,false,none,none JsonSchemaProperty ^^^^^^^^^^^^^^^^^^ .. code:: json { "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-198: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable additionalProperties,boolean,true,none,none description,string,true,none,none properties,:ref:`JsonSchemaProperties` ,true,none,none required,[string],true,none,none type,string,true,none,none KnowledgeBaseConfigInputUnion ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-199: Properties ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » pg_vector,:ref:`GTCHybidSQLPGVectorKnowledgeBaseInput` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » gtc_pg_vector,:ref:`GTCPGVectorKnowledgeBaseInput` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » gtc_hybrid_sql_pg_vector,:ref:`GTCHybidSQLPGVectorKnowledgeBaseInput` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » pgai_knowledge_base,:ref:`PGAIKnowledgeBaseKnowledgeBaseInput` ,true,none,none KnowledgeBaseConfigUnion ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-200: Properties ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » pg_vector,:ref:`GTCHybidSQLPGVectorKnowledgeBaseDetail` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » gtc_pg_vector,:ref:`GTCPGVectorKnowledgeBaseDetail` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » gtc_hybrid_sql_pg_vector,:ref:`GTCHybidSQLPGVectorKnowledgeBaseDetail` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » pgai_knowledge_base,:ref:`PGAIKnowledgeBaseKnowledgeBaseDetail` ,true,none,none KnowledgeBaseDetail ^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-201: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],true,none,none config,:ref:`KnowledgeBaseConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none embedding_model,:ref:`EmbeddingModel` ,false,none,none knowledge_base_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none schedule_expression,string,false,none,none transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,none type,string,true,none,none updated_at,string(date-time),true,none,none use_default_embedding_model,boolean,false,none,none KnowledgeBaseJobDetail ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-202: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none errors,\ :ref:`[Error <.#tocs_error>` ],false,none,none knowledge_base_id,string,true,none,none knowledge_base_job_id,string,true,none,none status,:ref:`KnowledgeBaseJobStatus` ,true,none,none status_detail,any,false,none,none KnowledgeBaseJobStatus ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" } .. _properties-203: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-19: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,CANCELLED KnowledgeBaseQueryDetail ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-204: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none entries,\ :ref:`[Entry <.#tocs_entry>` ],true,none,none knowledge_base_id,string,true,none,none knowledge_base_query_id,string,true,none,none query,string,true,none,none KnowledgeBaseSearchDetail ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-205: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none knowledge_base_id,string,true,none,none knowledge_base_search_id,string,true,none,none query,string,true,none,none result,string,true,none,none LibraryDetail ^^^^^^^^^^^^^ .. code:: json { "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-206: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_ids,[string],true,none,none description,string,false,none,none knowledge_base_ids,[string],true,none,none library_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none retriever_id,string,true,none,none updated_at,string(date-time),true,none,none ListApiKeysResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-207: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable api_keys,\ :ref:`tool_id ` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListAssetsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-208: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assets,\ :ref:`[AssetDetail <.#tocs_assetdetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none postfix,string,false,none,none prefix,string,false,none,none ListAssistantEventsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-209: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable count,number,true,none,none events,\ :ref:`[AssistantEventDetail <.#tocs_assistanteventdetail>` ],true,none,none limit,number,true,none,none next_offset,number,true,none,none offset,number,true,none,none total_count,number,true,none,none ListAssistantRunsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-210: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_runs,\ :ref:`[AssistantRunDetail <.#tocs_assistantrundetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListAssistantsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-211: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistants,\ :ref:`[AssistantDetail <.#tocs_assistantdetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListBucketsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-212: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable buckets,\ :ref:`[BucketDetail <.#tocs_bucketdetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListConnectionsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-213: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable connections,\ :ref:`[ConnectionDetail <.#tocs_connectiondetail>` ],false,none,none ListDataConnectorsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-214: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable data_connectors,\ :ref:`[DataConnectorDetail <.#tocs_dataconnectordetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListDataJobsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-215: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable data_jobs,\ :ref:`[DataJobDetail <.#tocs_datajobdetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListEventsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-216: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable count,number,true,none,none events,\ :ref:`[EventDetail <.#tocs_eventdetail>` ],true,none,none limit,number,true,none,none next_offset,number,true,none,none offset,number,true,none,none total_count,number,true,none,none ListFunctionDeploymentsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-217: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable deployments,\ :ref:`[FunctionDeploymentDetail <.#tocs_functiondeploymentdetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListFunctionRunLogsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _properties-218: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable logs,[string],true,none,none ListFunctionRunsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-219: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable function_runs,\ :ref:`[FunctionRunDetail <.#tocs_functionrundetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListFunctionsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-220: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable functions,\ :ref:`[FunctionDetail <.#tocs_functiondetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListIntegrationsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-221: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable integrations,\ :ref:`[IntegrationDetail <.#tocs_integrationdetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListInvitesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-222: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable invites,\ :ref:`[InviteDetail <.#tocs_invitedetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListKnowledgeBaseJobsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-223: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable knowledge_base_jobs,\ :ref:`[KnowledgeBaseJobDetail <.#tocs_knowledgebasejobdetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListKnowledgeBaseQueriesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-224: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable knowledge_base_queries,\ :ref:`[KnowledgeBaseQueryDetail <.#tocs_knowledgebasequerydetail>` ],false,none,none ListKnowledgeBaseSearchesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-225: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable knowledge_base_searches,\ :ref:`[KnowledgeBaseSearchDetail <.#tocs_knowledgebasesearchdetail>` ],false,none,none ListKnowledgeBasesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-226: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable knowledge_bases,\ :ref:`[KnowledgeBaseDetail <.#tocs_knowledgebasedetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListLibrariesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-227: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable libraries,\ :ref:`[LibraryDetail <.#tocs_librarydetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListMessagesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-228: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable messages,\ :ref:`[MessageDetail <.#tocs_messagedetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListModelsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-229: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable models,\ :ref:`[ModelDetail <.#tocs_modeldetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListOrganizationApiKeysResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-230: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable api_keys,\ :ref:`tool_id ` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListOrganizationUsersResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-231: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none users,\ :ref:`[OrganizationUserDetail <.#tocs_organizationuserdetail>` ],true,none,none ListOrganizationsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-232: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable organizations,\ :ref:`[OrganizationDetail <.#tocs_organizationdetail>` ],false,none,none ListRetrieverComponentsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-233: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none retriever_components,\ :ref:`[RetrieverComponentDetail <.#tocs_retrievercomponentdetail>` ],true,none,none ListRetrieversResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-234: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none retrievers,\ :ref:`[RetrieverDetail <.#tocs_retrieverdetail>` ],true,none,none ListRulesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-235: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none rules,\ :ref:`[RuleDetail <.#tocs_ruledetail>` ],true,none,none ListRulesetsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-236: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none rulesets,\ :ref:`tool_id ` ],true,none,none ListSecretsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-237: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none secrets,\ :ref:`[SecretDetail <.#tocs_secretdetail>` ],true,none,none ListSpansResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-238: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable page,number,false,none,none spans,\ :ref:`[SpanDetail <.#tocs_spandetail>` ],true,none,none ListStructureDeploymentsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-239: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable deployments,\ :ref:`[StructureDeploymentDetail <.#tocs_structuredeploymentdetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListStructureRunLogsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _properties-240: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable logs,[string],true,none,none ListStructureRunsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-241: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none structure_runs,\ :ref:`[StructureRunDetail <.#tocs_structurerundetail>` ],true,none,none ListStructuresResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-242: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none structures,\ :ref:`[StructureDetail <.#tocs_structuredetail>` ],true,none,none ListThreadsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-243: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none threads,\ :ref:`[ThreadDetail <.#tocs_threaddetail>` ],true,none,none ListToolDeploymentsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-244: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable deployments,\ :ref:`[ToolDeploymentDetail <.#tocs_tooldeploymentdetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListToolRunLogsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _properties-245: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable logs,[string],true,none,none ListToolRunsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-246: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none tool_runs,\ :ref:`[ToolRunDetail <.#tocs_toolrundetail>` ],true,none,none ListToolsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-247: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`Pagination` ,true,none,none tools,\ :ref:`[ToolDetail <.#tocs_tooldetail>` ],true,none,none ListUserInvitesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-248: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable invites,\ :ref:`[InviteDetail <.#tocs_invitedetail>` ],true,none,none pagination,:ref:`Pagination` ,true,none,none ListUsersResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-249: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable users,\ :ref:`[UserDetail <.#tocs_userdetail>` ],false,none,none MessageContent ^^^^^^^^^^^^^^ .. code:: json { "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-250: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable artifact,:ref:`Artifact` ,true,none,none type,string,true,none,none MessageDetail ^^^^^^^^^^^^^ .. code:: json { "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-251: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none index,number,true,none,none input,string,true,none,none message_id,string,true,none,none metadata,:ref:`Metadata` ,true,none,none output,string,true,none,none thread_id,string,true,none,none updated_at,string(date-time),true,none,none MessageInput ^^^^^^^^^^^^ .. code:: json { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "required": [ "input", "output" ], "type": "object" } .. _properties-252: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable input,string,true,none,none metadata,:ref:`Metadata` ,false,none,none output,string,true,none,none Meta ^^^^ .. code:: json { "additionalProperties": { "type": "string" }, "type": "object" } .. _properties-253: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable **additionalProperties** ,string,false,none,none Metadata ^^^^^^^^ .. code:: json { "additionalProperties": {}, "type": "object" } .. _properties-254: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable **additionalProperties** ,any,false,none,none ModelDetail ^^^^^^^^^^^ .. code:: json { "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-255: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable default,boolean,true,none,none description,string,false,none,none model_name,string,true,none,none model_type,:ref:`ModelType` ,true,none,none ModelTokenCounts ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "input": { "format": "float", "type": "number" }, "output": { "format": "float", "type": "number" } }, "type": "object" } .. _properties-256: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable input,number(float),false,none,none output,number(float),false,none,none ModelTokenCountsMap ^^^^^^^^^^^^^^^^^^^ .. code:: json { "additionalProperties": { "properties": { "input": { "format": "float", "type": "number" }, "output": { "format": "float", "type": "number" } }, "type": "object" }, "type": "object" } .. _properties-257: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable **additionalProperties** ,:ref:`ModelTokenCounts` ,false,none,none ModelType ^^^^^^^^^ .. code:: json { "enum": [ "chat", "embedding", "rerank", "image_generation", "unknown" ], "type": "string" } .. _properties-258: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-20: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,chat *anonymous*,embedding *anonymous*,rerank *anonymous*,image_generation *anonymous*,unknown ObservabilityEvent ^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "attributes": {}, "name": { "type": "string" }, "timestamp": { "format": "date-time", "type": "string" } }, "required": [ "attributes", "name", "timestamp" ], "type": "object" } .. _properties-259: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable attributes,any,true,none,none name,string,true,none,none timestamp,string(date-time),true,none,none OrganizationDetail ^^^^^^^^^^^^^^^^^^ .. code:: json { "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-260: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none default_bucket_id,string,true,none,none description,string,true,none,none entitlement,any,true,none,none allOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,:ref:`Entitlement` ,false,none,none and .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,any,false,none,none continued .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable model_config,:ref:`OrganizationModelConfig` ,false,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none OrganizationModelConfig ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-261: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable default_chat_model,string,false,none,none default_embedding_model,string,false,none,none default_image_generation_model,string,false,none,none default_rerank_model,string,false,none,none OrganizationUserDetail ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-262: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable email,string,true,none,none user_id,string,true,none,none PGAIKnowledgeBaseKnowledgeBaseDetail ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } .. _properties-263: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable knowledge_base_name,string,true,none,none query_schema,any,true,none,none PGAIKnowledgeBaseKnowledgeBaseInput ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "type": "object" } .. _properties-264: Properties ^^^^^^^^^^ - None\* PGVectorKnowledgeBaseDetail ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-265: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable connection_string,string,true,none,none embedding_model,string,true,none,none query_schema,any,true,none,none use_default_embedding_model,boolean,true,none,none PGVectorKnowledgeBaseInput ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-266: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable connection_string,string,true,none,none embedding_model,string,false,none,none password,string,true,none,none use_default_embedding_model,boolean,false,none,none Pagination ^^^^^^^^^^ .. code:: json { "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-267: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable next_page,number,false,none,none page_number,number,true,none,none page_size,number,true,none,none previous_page,number,false,none,none total_count,number,true,none,none total_pages,number,true,none,none Period ^^^^^^ .. code:: json { "enum": [ "1m", "1h", "1d", "1w" ], "type": "string" } .. _properties-268: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-21: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,1m *anonymous*,1h *anonymous*,1d *anonymous*,1w QueryKnowledgeBaseRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "query": { "type": "string" }, "query_args": {} }, "type": "object" } .. _properties-269: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable query,string,false,none,none query_args,any,false,none,none QueryKnowledgeBaseResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-270: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none entries,\ :ref:`[Entry <.#tocs_entry>` ],true,none,none knowledge_base_id,string,true,none,none knowledge_base_query_id,string,true,none,none query,string,true,none,none QueryRetrieverRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "query": { "type": "string" }, "retriever_components_query_args": {} }, "required": [ "query" ], "type": "object" } .. _properties-271: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable query,string,true,none,none retriever_components_query_args,any,false,none,none QueryRetrieverResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "outputs": { "items": {}, "type": "array" } }, "required": [ "outputs" ], "type": "object" } .. _properties-272: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable outputs,[any],true,none,none RespondToInviteRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "response": { "enum": [ "ACCEPTED", "REJECTED" ], "type": "string" } }, "required": [ "response" ], "type": "object" } .. _properties-273: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable response,:ref:`InviteResponseStatus` ,true,none,none RetrieverComponentDetail ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-274: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none retriever_component_id,string,true,none,none type,string,true,none,none updated_at,string(date-time),true,none,none RetrieverComponentInput ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-275: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,false,none,none description,string,false,none,none name,string,true,none,none type,string,true,none,none RetrieverDetail ^^^^^^^^^^^^^^^ .. code:: json { "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-276: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none retriever_components,\ :ref:`[RetrieverComponentDetail <.#tocs_retrievercomponentdetail>` ],true,none,none retriever_components_schema,any,true,none,none retriever_id,string,true,none,none updated_at,string(date-time),true,none,none RuleDetail ^^^^^^^^^^ .. code:: json { "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-277: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none rule,string,true,none,none rule_id,string,true,none,none updated_at,string(date-time),true,none,none RulesetDetail ^^^^^^^^^^^^^ .. code:: json { "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-278: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none rule_ids,[string],true,none,none ruleset_id,string,true,none,none updated_at,string(date-time),true,none,none RunCountGauge ^^^^^^^^^^^^^ .. code:: json { "properties": { "active_count": { "type": "number" }, "total_count": { "type": "number" } }, "type": "object" } .. _properties-279: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active_count,number,false,none,none total_count,number,false,none,none RunDurationGauge ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "activity_durations": { "items": { "properties": { "activity_type": { "type": "string" }, "seconds": { "type": "number" } }, "type": "object" }, "type": "array" }, "total_seconds": { "type": "number" } }, "type": "object" } .. _properties-280: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable activity_durations,\ :ref:`[ActivityDuration <.#tocs_activityduration>` ],false,none,none total_seconds,number,false,none,none S3ConnectorDetail ^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } .. _properties-281: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable aws_access_key_id,string,true,none,none uris,[string],true,none,none S3ConnectorInput ^^^^^^^^^^^^^^^^ .. code:: json { "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-282: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable aws_access_key_id,string,true,none,none aws_secret_access_key,string,true,none,none uris,[string],true,none,none SearchKnowledgeBaseRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "query": { "type": "string" }, "query_args": {} }, "required": [ "query" ], "type": "object" } .. _properties-283: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable query,string,true,none,none query_args,any,false,none,none SearchKnowledgeBaseResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-284: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none knowledge_base_id,string,true,none,none knowledge_base_search_id,string,true,none,none query,string,true,none,none result,string,true,none,none SecretDetail ^^^^^^^^^^^^ .. code:: json { "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-285: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none last_used,string(date-time),true,none,none name,string,true,none,none organization_id,string,true,none,none secret_id,string,true,none,none updated_at,string(date-time),true,none,none ServiceErrorResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _properties-286: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable errors,[any],false,none,none type,string,true,none,none SlackDetail ^^^^^^^^^^^ .. code:: json { "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-287: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable app_description,string,true,none,none app_display_name,string,true,none,none app_manifest,any,true,none,none app_name,string,true,none,none bot_token_secret_ref,string,true,none,none signing_secret_secret_ref,string,true,none,none SlackInput ^^^^^^^^^^ .. code:: json { "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-288: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable app_description,string,true,none,none app_display_name,string,true,none,none app_name,string,true,none,none bot_token_secret_ref,string,false,none,none signing_secret_secret_ref,string,false,none,none SpanDetail ^^^^^^^^^^ .. code:: json { "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-289: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable attributes,any,true,none,none end_time,string(date-time),true,none,none events,:ref:`ObservabilityEvent` ,true,none,none name,string,true,none,none parent_id,string,false,none,none span_id,string,true,none,none start_time,string(date-time),true,none,none status,:ref:`SpanStatus` ,true,none,none trace_id,string,true,none,none SpanStatus ^^^^^^^^^^ .. code:: json { "enum": [ "UNSET", "OK", "ERROR" ], "type": "string" } .. _properties-290: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-22: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,UNSET *anonymous*,OK *anonymous*,ERROR StreamMessageContent ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-291: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable artifact,:ref:`Artifact` ,true,none,none type,string,true,none,none StructureCode ^^^^^^^^^^^^^ .. code:: json { "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-292: Properties ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » github,:ref:`GithubStructureCode` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » data_lake,:ref:`DataLakeStructureCode` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » default,:ref:`DefaultStructureCode` ,true,none,none StructureConnectorDetail ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } .. _properties-293: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],false,none,none structure_id,string,true,none,none StructureConnectorInput ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } .. _properties-294: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],false,none,none structure_id,string,true,none,none StructureDeploymentDetail ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-295: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`CodeSource` ,true,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,true,none,none status,:ref:`DeploymentStatus` ,true,none,none status_detail,any,false,none,none structure_id,string,true,none,none StructureDetail ^^^^^^^^^^^^^^^ .. code:: json { "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-296: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none structure_config_file,string,false,none,none structure_id,string,true,none,none updated_at,string(date-time),true,none,none webhook_enabled,boolean,true,none,none StructureRunDetail ^^^^^^^^^^^^^^^^^^ .. code:: json { "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-297: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,none completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none output,any,false,none,none output_timestamp,number(double),false,none,none started_at,string(date-time)¦null,true,none,none status,:ref:`StructureRunStatus` ,true,none,none status_detail,any,false,none,none structure_id,string,true,none,none structure_run_id,string,true,none,none updated_at,string(date-time),true,none,none StructureRunStatus ^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" } .. _properties-298: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-23: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,STARTING *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,ERROR *anonymous*,CANCELLED StructuredColumnDetail ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" } .. _properties-299: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable column_name,string,true,none,none sql_type,string,true,none,none StructuredColumnInput ^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" } .. _properties-300: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable column_name,string,true,none,none description,string,true,none,none sql_type,string,true,none,none ThreadDetail ^^^^^^^^^^^^ .. code:: json { "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-301: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none thread_id,string,true,none,none updated_at,string(date-time),true,none,none TokenCountGauge ^^^^^^^^^^^^^^^ .. code:: json { "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-302: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable by_model,:ref:`ModelTokenCountsMap` ,false,none,none input,number(float),false,none,none output,number(float),false,none,none ToolCode ^^^^^^^^ .. code:: json { "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-303: Properties ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » github,:ref:`GithubToolCode` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » data_lake,:ref:`DataLakeToolCode` ,true,none,none xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,none » default,:ref:`DefaultToolCode` ,true,none,none ToolDeploymentDetail ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-304: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`CodeSource` ,true,none,none completed_at,string(date-time)¦null,false,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,true,none,none status,:ref:`DeploymentStatus` ,true,none,none status_detail,any,false,none,none tool_id,string,true,none,none ToolDetail ^^^^^^^^^^ .. code:: json { "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-305: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none tool_config_file,string,false,none,none tool_id,string,true,none,none updated_at,string(date-time),true,none,none ToolRunDetail ^^^^^^^^^^^^^ .. code:: json { "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-306: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable completed_at,string(date-time)¦null,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none deployment_id,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none input,any,true,none,none output,any,false,none,none output_timestamp,number(double),false,none,none runtime_path,string,true,none,none started_at,string(date-time)¦null,true,none,none status,:ref:`ToolRunStatus` ,true,none,none status_detail,any,false,none,none tool_id,string,true,none,none tool_run_id,string,true,none,none updated_at,string(date-time),true,none,none ToolRunStatus ^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" } .. _properties-307: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,none .. _enumerated-values-24: Enumerated Values ''''''''''''''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,STARTING *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,ERROR *anonymous*,CANCELLED TransformDetail ^^^^^^^^^^^^^^^ .. code:: json { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" } .. _properties-308: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable structure,:ref:`StructureConnectorDetail` ,false,none,none TransformInput ^^^^^^^^^^^^^^ .. code:: json { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "type": "object" } .. _properties-309: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable structure,:ref:`StructureConnectorInput` ,true,none,none UnstructuredColumnDetail ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" } .. _properties-310: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable column_name,string,true,none,none UnstructuredColumnInput ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" } .. _properties-311: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable column_name,string,true,none,none description,string,true,none,none UpdateApiKeyRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _properties-312: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,false,none,none UpdateApiKeyResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-313: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active,boolean,true,none,none api_key_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none last_used,string(date-time),true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateAssistantRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-314: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,false,none,none input,string,false,none,none knowledge_base_ids,[string],false,none,none name,string,false,none,none ruleset_ids,[string],false,none,none structure_ids,[string],false,none,none tool_ids,[string],false,none,none UpdateAssistantResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-315: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none input,string,false,none,none knowledge_base_ids,[string],true,none,none name,string,true,none,none organization_id,string,true,none,none retriever_ids,[string],true,none,none ruleset_ids,[string],true,none,none structure_ids,[string],true,none,none tool_ids,[string],true,none,none updated_at,string(date-time),true,none,none UpdateBucketRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" } .. _properties-316: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,false,none,none UpdateBucketResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-317: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateDataConnectorRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-318: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,:ref:`DataConnectorConfigInputUnion` ,false,none,none description,string,false,none,none name,string,false,none,none schedule_expression,string,false,none,none UpdateDataConnectorResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-319: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,:ref:`DataConnectorConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_id,string,true,none,none data_job_id,string,false,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none schedule_expression,string,false,none,none transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,none type,string,true,none,none updated_at,string(date-time),true,none,none UpdateFunctionRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-320: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeFunctionCode` ,false,none,none description,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none function_config_file,string,false,none,none name,string,false,none,none UpdateFunctionResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-321: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeFunctionCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none function_config_file,string,false,none,none function_id,string,true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateIntegrationRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-322: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],false,none,none config,:ref:`IntegrationConfigInputUnion` ,false,none,none description,string,false,none,none name,string,false,none,none structure_ids,[string],false,none,none type,:ref:`IntegrationType` ,false,none,none UpdateIntegrationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-323: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],true,none,none config,:ref:`IntegrationConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none integration_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none structure_ids,[string],true,none,none type,:ref:`IntegrationType` ,true,none,none updated_at,string(date-time),true,none,none UpdateKnowledgeBaseRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-324: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],false,none,none config,:ref:`KnowledgeBaseConfigInputUnion` ,true,none,none description,string,false,none,none embedding_model,:ref:`EmbeddingModel` ,false,none,none name,string,false,none,none schedule_expression,string,false,none,none transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,none type,string,true,none,none use_default_embedding_model,boolean,false,none,none UpdateKnowledgeBaseResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-325: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],true,none,none config,:ref:`KnowledgeBaseConfigUnion` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none embedding_model,:ref:`EmbeddingModel` ,false,none,none knowledge_base_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none schedule_expression,string,false,none,none transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,none type,string,true,none,none updated_at,string(date-time),true,none,none use_default_embedding_model,boolean,false,none,none UpdateLibraryRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-326: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable data_connector_ids,[string],true,none,none description,string,false,none,none knowledge_base_configs,\ :ref:`[KnowledgeBaseConfigInputUnion <.#tocs_knowledgebaseconfiginputunion>` ],true,none,none name,string,true,none,none UpdateLibraryResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-327: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none data_connector_ids,[string],true,none,none description,string,false,none,none knowledge_base_ids,[string],true,none,none library_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none retriever_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateMessageRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "type": "object" } .. _properties-328: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable input,string,false,none,none metadata,:ref:`Metadata` ,false,none,none output,string,false,none,none UpdateMessageResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-329: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none index,number,true,none,none input,string,true,none,none message_id,string,true,none,none metadata,:ref:`Metadata` ,true,none,none output,string,true,none,none thread_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateOrganizationRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-330: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable model_config,:ref:`OrganizationModelConfig` ,false,none,none name,string,false,none,none UpdateOrganizationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-331: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none default_bucket_id,string,true,none,none description,string,true,none,none entitlement,any,true,none,none allOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,:ref:`Entitlement` ,false,none,none and .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,any,false,none,none continued .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable model_config,:ref:`OrganizationModelConfig` ,false,none,none name,string,true,none,none organization_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateRetrieverComponentRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-332: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,none description,string,false,none,none name,string,false,none,none type,string,true,none,none UpdateRetrieverComponentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-333: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none retriever_component_id,string,true,none,none type,string,true,none,none updated_at,string(date-time),true,none,none UpdateRetrieverRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-334: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,false,none,none name,string,false,none,none retriever_component_ids,[string],false,none,none retriever_components,\ :ref:`[RetrieverComponentInput <.#tocs_retrievercomponentinput>` ],false,none,none UpdateRetrieverResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-335: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,false,none,none name,string,true,none,none organization_id,string,true,none,none retriever_components,\ :ref:`[RetrieverComponentDetail <.#tocs_retrievercomponentdetail>` ],true,none,none retriever_components_schema,any,true,none,none retriever_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateRuleRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "rule": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "type": "object" } .. _properties-336: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable metadata,:ref:`Metadata` ,false,none,none name,string,false,none,none rule,string,false,none,none UpdateRuleResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-337: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none created_by,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none rule,string,true,none,none rule_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateRulesetRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-338: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,false,none,none description,string,false,none,none metadata,:ref:`Metadata` ,false,none,none name,string,false,none,none rule_ids,[string],false,none,none UpdateRulesetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-339: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none rule_ids,[string],true,none,none ruleset_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateSecretRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "value": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _properties-340: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,false,none,none value,string,false,none,none UpdateSecretResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-341: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none last_used,string(date-time),true,none,none name,string,true,none,none organization_id,string,true,none,none secret_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateStructureRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-342: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,false,none,none description,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none name,string,false,none,none structure_config_file,string,false,none,none webhook_enabled,boolean,false,none,none UpdateStructureResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-343: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none structure_config_file,string,false,none,none structure_id,string,true,none,none updated_at,string(date-time),true,none,none webhook_enabled,boolean,true,none,none UpdateThreadRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-344: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,false,none,none messages,\ :ref:`[MessageInput <.#tocs_messageinput>` ],false,none,none metadata,:ref:`Metadata` ,false,none,none name,string,false,none,none UpdateThreadResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-345: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none metadata,:ref:`Metadata` ,true,none,none name,string,true,none,none organization_id,string,true,none,none thread_id,string,true,none,none updated_at,string(date-time),true,none,none UpdateToolRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-346: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,false,none,none description,string,false,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,none name,string,false,none,none tool_config_file,string,false,none,none UpdateToolResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "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-347: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,true,none,none created_at,string(date-time),true,none,none created_by,string,true,none,none description,string,true,none,none env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,none latest_deployment_id,string,true,none,none name,string,true,none,none organization_id,string,true,none,none tool_config_file,string,false,none,none tool_id,string,true,none,none updated_at,string(date-time),true,none,none UserDetail ^^^^^^^^^^ .. code:: json { "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-348: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,none email,string,true,none,none name,string,false,none,none organizations,[string],true,none,none updated_at,string(date-time),true,none,none user_id,string,true,none,none WebhookDetail ^^^^^^^^^^^^^ .. code:: json { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } .. _properties-349: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable disable_api_key_param,boolean,true,none,none integration_endpoint,string,true,none,none WebhookInput ^^^^^^^^^^^^ .. code:: json { "properties": { "disable_api_key_param": { "type": "boolean" } }, "type": "object" } .. _properties-350: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable disable_api_key_param,boolean,false,none,none WebscraperDetail ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } .. _properties-351: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable urls,[string],true,none,none WebscraperInput ^^^^^^^^^^^^^^^ .. code:: json { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } .. _properties-352: Properties ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable urls,[string],true,none,none