Gen AI Builder v2023-09-19

Authentication

• HTTP Authentication, scheme: Bearer HTTP Bearer authentication

Default

ListUsers

GET /users

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListUsers 200 response	ListUsersResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
api_key_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteApiKey 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
api_key_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetApiKey 200 response	GetApiKeyResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
api_key_id	path	string	true	none
body	body	UpdateApiKeyRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateApiKey 200 response	UpdateApiKeyResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
organization_id	path	string	true	none
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListOrganizationApiKeys 200 response	ListOrganizationApiKeysResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
organization_id	path	string	true	none
body	body	CreateOrganizationApiKeyRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateOrganizationApiKey 201 response	CreateOrganizationApiKeyResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
user_id	path	string	true	none
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListApiKeys 200 response	ListApiKeysResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
user_id	path	string	true	none
body	body	CreateApiKeyRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateApiKey 201 response	CreateApiKeyResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
assistant_run_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetAssistantRun 200 response	GetAssistantRunResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
assistant_run_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	CancelAssistantRun 200 response	CancelAssistantRunResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
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

Parameter	Value
status	QUEUED
status	STARTING
status	RUNNING
status	SUCCEEDED
status	FAILED
status	ERROR
status	CANCELLED

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListAssistantRuns 200 response	ListAssistantRunsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
assistant_id	path	string	true	none
body	body	CreateAssistantRunRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateAssistantRun 201 response	CreateAssistantRunResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
assistant_run_id	path	string	true	none
limit	query	string	false	none
offset	query	string	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListAssistantEvents 200 response	ListAssistantEventsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
assistant_run_id	path	string	true	none

Example responses

400 Response

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
200	GetToken	GetAssistantRunEventsSSE 200 response	GetAssistantRunEventsSSEOutputPayload
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
event_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetEvent 200 response	GetEventResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
structure_run_id	path	string	true	none
limit	query	string	false	none
offset	query	string	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListEvents 200 response	ListEventsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
structure_run_id	path	string	true	none
body	body	CreateEventsRequestContent	false	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
202	Accepted	CreateEvents 202 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
structure_run_id	path	string	true	none

Example responses

400 Response

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
200	GetToken	GetStructureRunEventsSSE 200 response	GetStructureRunEventsSSEOutputPayload
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListAssistants 200 response	ListAssistantsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateAssistantRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateAssistant 201 response	CreateAssistantResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
assistant_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteAssistant 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
assistant_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetAssistant 200 response	GetAssistantResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
assistant_id	path	string	true	none
body	body	UpdateAssistantRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateAssistant 200 response	UpdateAssistantResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "price_lookup_key": {
      "type": "string"
    }
  },
  "required": [
    "price_lookup_key"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateCheckoutSessionRequestContent	true	none

Example responses

{
  "properties": {
    "redirect_url": {
      "type": "string"
    }
  },
  "required": [
    "redirect_url"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateCheckoutSession 201 response	CreateCheckoutSessionResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "billing_management_url": {
      "type": "string"
    }
  },
  "required": [
    "billing_management_url"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateBillingManagementUrl 201 response	CreateBillingManagementUrlResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListBuckets 200 response	ListBucketsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateBucketRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateBucket 201 response	CreateBucketResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
bucket_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteBucket 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
bucket_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetBucket 200 response	GetBucketResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
bucket_id	path	string	true	none
body	body	UpdateBucketRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateBucket 200 response	UpdateBucketResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "operation": {
      "enum": [
        "PUT",
        "GET"
      ],
      "type": "string"
    }
  },
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
name	path	string	true	none
bucket_id	path	string	true	none
body	body	CreateAssetUrlRequestContent	false	none

Example responses

{
  "properties": {
    "headers": {
      "additionalProperties": {},
      "type": "object"
    },
    "url": {
      "type": "string"
    }
  },
  "required": [
    "headers",
    "url"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
200	GetToken	CreateAssetUrl 200 response	CreateAssetUrlResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
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

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListAssets 200 response	ListAssetsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
bucket_id	path	string	true	none
body	body	CreateAssetRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateAsset 201 response	CreateAssetResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
name	path	string	true	none
bucket_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteAsset 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
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

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetAsset 200 response	GetAssetResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateChatMessageRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateChatMessage 201 response	CreateChatMessageResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateChatMessageStreamRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateChatMessageStream 201 response	CreateChatMessageStreamResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetConfig 200 response	GetConfigResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none
type	query	string	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListConnections 200 response	ListConnectionsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateConnectionRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateConnection 201 response	CreateConnectionResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
connection_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteConnection 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
connection_id	path	string	true	none

Example responses

{
  "properties": {
    "access_token": {
      "type": "string"
    }
  },
  "required": [
    "access_token"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
200	GetToken	GetToken 200 response	GetTokenResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
start_time	query	string(date-time)	false	none
end_time	query	string(date-time)	false	none
period	query	Period	false	none
structure_ids	query	string	false	none

Enumerated Values

Parameter	Value
period	1m
period	1h
period	1d
period	1w

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetStructuresDashboard 200 response	GetStructuresDashboardResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListStructures 200 response	ListStructuresResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateStructureRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateStructure 201 response	CreateStructureResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
structure_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteStructure 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
structure_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetStructure 200 response	GetStructureResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
structure_id	path	string	true	none
body	body	UpdateStructureRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateStructure 200 response	UpdateStructureResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
structure_id	path	string	true	none
api_key	query	string	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	InvokeStructureWebhookGet 200 response	InvokeStructureWebhookGetResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
structure_id	path	string	true	none
api_key	query	string	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	InvokeStructureWebhookPost 200 response	InvokeStructureWebhookPostResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListDataConnectors 200 response	ListDataConnectorsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateDataConnectorRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateDataConnector 201 response	CreateDataConnectorResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
data_connector_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteDataConnector 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
data_connector_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetDataConnector 200 response	GetDataConnectorResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
data_connector_id	path	string	true	none
body	body	UpdateDataConnectorRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateDataConnector 200 response	UpdateDataConnectorResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
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

Parameter	Value
status	QUEUED
status	RUNNING
status	SUCCEEDED
status	FAILED
status	CANCELLED

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListDataJobs 200 response	ListDataJobsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
data_connector_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
202	Accepted	CreateDataJob 202 response	CreateDataJobResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
data_job_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetDataJob 200 response	GetDataJobResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
data_job_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	CancelDataJob 200 response	CancelDataJobResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
deployment_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetDeployment 200 response	GetDeploymentResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
function_id	path	string	true	none
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListFunctionDeployments 200 response	ListFunctionDeploymentsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
function_id	path	string	true	none
body	body	CreateFunctionDeploymentRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
202	Accepted	CreateFunctionDeployment 202 response	CreateFunctionDeploymentResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
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

Parameter	Value
status	QUEUED
status	DEPLOYING
status	SUCCEEDED
status	FAILED
status	ERROR

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListStructureDeployments 200 response	ListStructureDeploymentsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
structure_id	path	string	true	none
body	body	CreateStructureDeploymentRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
202	Accepted	CreateStructureDeployment 202 response	CreateStructureDeploymentResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
tool_id	path	string	true	none
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListToolDeployments 200 response	ListToolDeploymentsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
tool_id	path	string	true	none
body	body	CreateToolDeploymentRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
202	Accepted	CreateToolDeployment 202 response	CreateToolDeploymentResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
function_run_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetFunctionRun 200 response	GetFunctionRunResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
function_run_id	path	string	true	none

Example responses

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
200	GetToken	ListFunctionRunLogs 200 response	ListFunctionRunLogsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
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

Parameter	Value
status	QUEUED
status	STARTING
status	RUNNING
status	SUCCEEDED
status	FAILED
status	ERROR
status	CANCELLED

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListFunctionRuns 200 response	ListFunctionRunsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListFunctions 200 response	ListFunctionsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateFunctionRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateFunction 201 response	CreateFunctionResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
function_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteFunction 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
function_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetFunction 200 response	GetFunctionResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
function_id	path	string	true	none
body	body	UpdateFunctionRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateFunction 200 response	UpdateFunctionResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
function_id	path	string	true	none

Example responses

{}

Responses

Status	Meaning	Description	Schema
200	GetToken	CreateFunctionExecutionGet 200 response	CreateFunctionExecutionGetOutputPayload
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{}

Parameters

Name	In	Type	Required	Description
function_id	path	string	true	none
body	body	CreateFunctionExecutionPostInputPayload	false	none

Example responses

{}

Responses

Status	Meaning	Description	Schema
200	GetToken	CreateFunctionExecutionPost 200 response	CreateFunctionExecutionPostOutputPayload
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListIntegrations 200 response	ListIntegrationsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateIntegrationRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateIntegration 201 response	CreateIntegrationResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
integration_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteIntegration 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
integration_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetIntegration 200 response	GetIntegrationResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
integration_id	path	string	true	none
body	body	UpdateIntegrationRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateIntegration 200 response	UpdateIntegrationResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListUserInvites 200 response	ListUserInvitesResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
invite_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteInvite 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
invite_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetInvite 200 response	GetInviteResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "response": {
      "enum": [
        "ACCEPTED",
        "REJECTED"
      ],
      "type": "string"
    }
  },
  "required": [
    "response"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
invite_id	path	string	true	none
body	body	RespondToInviteRequestContent	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	RespondToInvite 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
organization_id	path	string	true	none
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListInvites 200 response	ListInvitesResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "email": {
      "maxLength": 254,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "email"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
organization_id	path	string	true	none
body	body	CreateInviteRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateInvite 201 response	CreateInviteResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
knowledge_base_job_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetKnowledgeBaseJob 200 response	GetKnowledgeBaseJobResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
knowledge_base_job_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	CancelKnowledgeBaseJob 200 response	CancelKnowledgeBaseJobResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
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

Parameter	Value
status	QUEUED
status	RUNNING
status	SUCCEEDED
status	FAILED
status	CANCELLED

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListKnowledgeBaseJobs 200 response	ListKnowledgeBaseJobsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
202	Accepted	CreateKnowledgeBaseJob 202 response	CreateKnowledgeBaseJobResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
knowledge_base_query_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetKnowledgeBaseQuery 200 response	GetKnowledgeBaseQueryResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
knowledge_base_search_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetKnowledgeBaseSearch 200 response	GetKnowledgeBaseSearchResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListKnowledgeBases 200 response	ListKnowledgeBasesResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateKnowledgeBaseRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateKnowledgeBase 201 response	CreateKnowledgeBaseResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteKnowledgeBase 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetKnowledgeBase 200 response	GetKnowledgeBaseResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	none
body	body	UpdateKnowledgeBaseRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateKnowledgeBase 200 response	UpdateKnowledgeBaseResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	none
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListKnowledgeBaseQueries 200 response	ListKnowledgeBaseQueriesResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "query": {
      "type": "string"
    },
    "query_args": {}
  },
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	none
body	body	QueryKnowledgeBaseRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	QueryKnowledgeBase 200 response	QueryKnowledgeBaseResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "query": {
      "type": "string"
    },
    "query_args": {}
  },
  "required": [
    "query"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	none
body	body	SearchKnowledgeBaseRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	SearchKnowledgeBase 200 response	SearchKnowledgeBaseResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	none
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListKnowledgeBaseSearches 200 response	ListKnowledgeBaseSearchesResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListLibraries 200 response	ListLibrariesResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateLibraryRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateLibrary 201 response	CreateLibraryResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
library_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteLibrary 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
library_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetLibrary 200 response	GetLibraryResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
library_id	path	string	true	none
body	body	UpdateLibraryRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateLibrary 200 response	UpdateLibraryResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
message_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteMessage 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
message_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetMessage 200 response	GetMessageResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "input": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    }
  },
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
message_id	path	string	true	none
body	body	UpdateMessageRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateMessage 200 response	UpdateMessageResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
thread_id	path	string	true	none
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListMessages 200 response	ListMessagesResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "input": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    }
  },
  "required": [
    "input",
    "output"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
thread_id	path	string	true	none
body	body	CreateMessageRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateMessage 201 response	CreateMessageResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none
model_type	query	string	false	none
default	query	boolean	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListModels 200 response	ListModelsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListOrganizations 200 response	ListOrganizationsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "description": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateOrganizationRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateOrganization 201 response	CreateOrganizationResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
organization_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteOrganization 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
organization_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetOrganization 200 response	GetOrganizationResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
organization_id	path	string	true	none
body	body	UpdateOrganizationRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateOrganization 200 response	UpdateOrganizationResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
organization_id	path	string	true	none
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListOrganizationUsers 200 response	ListOrganizationUsersResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
organization_id	path	string	true	none
user_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteOrganizationUser 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListRetrieverComponents 200 response	ListRetrieverComponentsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateRetrieverComponentRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateRetrieverComponent 201 response	CreateRetrieverComponentResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
retriever_component_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteRetrieverComponent 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
retriever_component_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetRetrieverComponent 200 response	GetRetrieverComponentResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
retriever_component_id	path	string	true	none
body	body	UpdateRetrieverComponentRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateRetrieverComponent 200 response	UpdateRetrieverComponentResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListRetrievers 200 response	ListRetrieversResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateRetrieverRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateRetriever 201 response	CreateRetrieverResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
retriever_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteRetriever 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
retriever_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetRetriever 200 response	GetRetrieverResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
retriever_id	path	string	true	none
body	body	UpdateRetrieverRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateRetriever 200 response	UpdateRetrieverResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "query": {
      "type": "string"
    },
    "retriever_components_query_args": {}
  },
  "required": [
    "query"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
retriever_id	path	string	true	none
body	body	QueryRetrieverRequestContent	true	none

Example responses

{
  "properties": {
    "outputs": {
      "items": {},
      "type": "array"
    }
  },
  "required": [
    "outputs"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
200	GetToken	QueryRetriever 200 response	QueryRetrieverResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none
ruleset_id	query	string	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListRules 200 response	ListRulesResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateRuleRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateRule 201 response	CreateRuleResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
rule_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteRule 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
rule_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetRule 200 response	GetRuleResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "rule": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
rule_id	path	string	true	none
body	body	UpdateRuleRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateRule 200 response	UpdateRuleResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none
alias	query	string	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListRulesets 200 response	ListRulesetsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateRulesetRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateRuleset 201 response	CreateRulesetResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
ruleset_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteRuleset 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
ruleset_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetRuleset 200 response	GetRulesetResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
ruleset_id	path	string	true	none
body	body	UpdateRulesetRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateRuleset 200 response	UpdateRulesetResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListSecrets 200 response	ListSecretsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "value": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name",
    "value"
  ],
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateSecretRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateSecret 201 response	CreateSecretResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
secret_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteSecret 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
secret_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetSecret 200 response	GetSecretResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "value": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Parameters

Name	In	Type	Required	Description
secret_id	path	string	true	none
body	body	UpdateSecretRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateSecret 200 response	UpdateSecretResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
structure_run_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetStructureRun 200 response	GetStructureRunResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
structure_run_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	CancelStructureRun 200 response	CancelStructureRunResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
structure_run_id	path	string	true	none

Example responses

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
200	GetToken	ListStructureRunLogs 200 response	ListStructureRunLogsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
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

Parameter	Value
status	QUEUED
status	STARTING
status	RUNNING
status	SUCCEEDED
status	FAILED
status	ERROR
status	CANCELLED

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListStructureRuns 200 response	ListStructureRunsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
structure_id	path	string	true	none
body	body	CreateStructureRunRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateStructureRun 201 response	CreateStructureRunResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
structure_run_id	path	string	true	none
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListSpans 200 response	ListSpansResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none
alias	query	string	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListThreads 200 response	ListThreadsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateThreadRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateThread 201 response	CreateThreadResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
thread_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteThread 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
thread_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetThread 200 response	GetThreadResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
thread_id	path	string	true	none
body	body	UpdateThreadRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateThread 200 response	UpdateThreadResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
tool_run_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetToolRun 200 response	GetToolRunResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
tool_run_id	path	string	true	none

Example responses

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
200	GetToken	ListToolRunLogs 200 response	ListToolRunLogsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
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

Parameter	Value
status	QUEUED
status	STARTING
status	RUNNING
status	SUCCEEDED
status	FAILED
status	ERROR
status	CANCELLED

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListToolRuns 200 response	ListToolRunsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
page	query	number	false	none
page_size	query	number	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	ListTools 200 response	ListToolsResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
body	body	CreateToolRequestContent	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateTool 201 response	CreateToolResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
tool_id	path	string	true	none

Example responses

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Responses

Status	Meaning	Description	Schema
204	No Content	DeleteTool 204 response	None
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
tool_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetTool 200 response	GetToolResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Name	In	Type	Required	Description
tool_id	path	string	true	none
body	body	UpdateToolRequestContent	false	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	UpdateTool 200 response	UpdateToolResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{}

Parameters

Name	In	Type	Required	Description
tool_id	path	string	true	none
activity_path	path	string	true	none
body	body	CreateToolActivityRunInputPayload	false	none

Example responses

{}

Responses

Status	Meaning	Description	Schema
200	GetToken	CreateToolActivityRun 200 response	CreateToolActivityRunOutputPayload
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
tool_id	path	string	true	none

Example responses

{}

Responses

Status	Meaning	Description	Schema
200	GetToken	GetToolOpenApiRun 200 response	GetToolOpenApiRunOutputPayload
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetUsage 200 response	GetUsageResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	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

Name	In	Type	Required	Description
user_id	path	string	true	none

Example responses

{
  "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

Status	Meaning	Description	Schema
200	GetToken	GetUser 200 response	GetUserResponseContent
400	Bad Request	ClientError 400 response	ClientErrorResponseContent
500	Internal Server Error	ServiceError 500 response	ServiceErrorResponseContent

Warning

To perform this operation, you must be authenticated by means of one of the following methods: smithy.api.httpBearerAuth

Schemas

ActivityDuration

{
  "properties": {
    "activity_type": {
      "type": "string"
    },
    "seconds": {
      "type": "number"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
activity_type	string	false	none	none
seconds	number	false	none	none

ApiKeyDetail

{
  "properties": {
    "active": {
      "type": "boolean"
    },
    "api_key_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "last_used": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "active",
    "api_key_id",
    "created_at",
    "created_by",
    "last_used",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "enum": [
    "PUT",
    "GET"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	PUT
anonymous	GET

AssetDetail

{
  "properties": {
    "bucket_id": {
      "type": "string"
    },
    "contents": {},
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "size": {
      "type": "number"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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	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

{
  "enum": [
    "QUEUED",
    "STARTING",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	QUEUED
anonymous	STARTING
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	ERROR
anonymous	CANCELLED

BucketDetail

{
  "properties": {
    "bucket_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "bucket_id",
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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	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

{
  "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

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	none
status	DataJobStatus	true	none	none
status_detail	any	false	none	none

CancelKnowledgeBaseJobResponseContent

{
  "properties": {
    "bytes_ingested": {
      "type": "number"
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "errors": {
      "items": {
        "properties": {
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "knowledge_base_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "knowledge_base_job_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "status": {
      "enum": [
        "QUEUED",
        "RUNNING",
        "SUCCEEDED",
        "FAILED",
        "CANCELLED"
      ],
      "type": "string"
    },
    "status_detail": {}
  },
  "required": [
    "created_at",
    "created_by",
    "knowledge_base_id",
    "knowledge_base_job_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	none
knowledge_base_id	string	true	none	none
knowledge_base_job_id	string	true	none	none
status	KnowledgeBaseJobStatus	true	none	none
status_detail	any	false	none	none

CancelStructureRunResponseContent

{
  "properties": {
    "args": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "output": {},
    "output_timestamp": {
      "format": "double",
      "type": "number"
    },
    "started_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "status": {
      "enum": [
        "QUEUED",
        "STARTING",
        "RUNNING",
        "SUCCEEDED",
        "FAILED",
        "ERROR",
        "CANCELLED"
      ],
      "type": "string"
    },
    "status_detail": {},
    "structure_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_run_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "args",
    "completed_at",
    "created_at",
    "created_by",
    "started_at",
    "status",
    "structure_id",
    "structure_run_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[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	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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
content	[MessageContent ]	true	none	none
role	string	true	none	none
usage	ChatMessageUsage	true	none	none

ChatMessageTool

{
  "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

Name	Type	Required	Restrictions	Description
activities	[ChatMessageToolActivity ]	true	none	none
name	string	true	none	none

ChatMessageToolActivity

{
  "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

Name	Type	Required	Restrictions	Description
description	string	true	none	none
json_schema	JsonSchema	true	none	none
name	string	true	none	none

ChatMessageUsage

{
  "properties": {
    "input_tokens": {
      "type": "number"
    },
    "output_tokens": {
      "type": "number"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "input_tokens",
    "output_tokens",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
input_tokens	number	true	none	none
output_tokens	number	true	none	none
type	string	true	none	none

ClientErrorResponseContent

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
errors	[any]	false	none	none
type	string	true	none	none

CodeSource

{
  "oneOf": [
    {
      "properties": {
        "github": {
          "properties": {
            "commit_sha": {
              "maxLength": 200,
              "minLength": 1,
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "required": [
        "github"
      ],
      "title": "github",
      "type": "object"
    },
    {
      "properties": {
        "data_lake": {
          "properties": {
            "asset_path": {
              "type": "string"
            },
            "bucket_id": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            }
          },
          "required": [
            "asset_path",
            "bucket_id"
          ],
          "type": "object"
        }
      },
      "required": [
        "data_lake"
      ],
      "title": "data_lake",
      "type": "object"
    }
  ]
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» github	GithubCodeSource	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data_lake	DataLakeCodeSource	true	none	none

CodeSourceInput

{
  "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

Name	Type	Required	Restrictions	Description
github	GithubCodeSourceInput	true	none	none

ConfluenceDetail

{
  "properties": {
    "atlassian_email": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "atlassian_email",
    "domain"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
atlassian_email	string	true	none	none
domain	string	true	none	none

ConfluenceInput

{
  "properties": {
    "atlassian_api_token": {
      "type": "string"
    },
    "atlassian_email": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "atlassian_api_token",
    "atlassian_email",
    "domain"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
atlassian_api_token	string	true	none	none
atlassian_email	string	true	none	none
domain	string	true	none	none

ConnectionCredentialsInput

{
  "oneOf": [
    {
      "properties": {
        "github": {
          "properties": {
            "auth_code": {
              "type": "string"
            }
          },
          "required": [
            "auth_code"
          ],
          "type": "object"
        }
      },
      "required": [
        "github"
      ],
      "title": "github",
      "type": "object"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
github	GitHubCredentialsInput	true	none	none

ConnectionDetail

{
  "properties": {
    "connection_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "connection_id",
    "created_at",
    "created_by",
    "name",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none

CreateApiKeyResponseContent

{
  "properties": {
    "active": {
      "type": "boolean"
    },
    "api_key_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "last_used": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "active",
    "api_key_id",
    "created_at",
    "created_by",
    "last_used",
    "name",
    "organization_id",
    "updated_at",
    "value"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none

CreateAssetResponseContent

{
  "properties": {
    "bucket_id": {
      "type": "string"
    },
    "contents": {},
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "size": {
      "type": "number"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "operation": {
      "enum": [
        "PUT",
        "GET"
      ],
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
operation	AssertUrlOperation	false	none	none

CreateAssetUrlResponseContent

{
  "properties": {
    "headers": {
      "additionalProperties": {},
      "type": "object"
    },
    "url": {
      "type": "string"
    }
  },
  "required": [
    "headers",
    "url"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
headers	Metadata	true	none	none
url	string	true	none	none

CreateAssistantRequestContent

{
  "properties": {
    "description": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "input": {
      "type": "string"
    },
    "knowledge_base_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "retriever_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "ruleset_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "structure_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "tool_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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	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

{
  "properties": {
    "billing_management_url": {
      "type": "string"
    }
  },
  "required": [
    "billing_management_url"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
billing_management_url	string	true	none	none

CreateBucketRequestContent

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none

CreateBucketResponseContent

{
  "properties": {
    "bucket_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "bucket_id",
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
driver_configuration	ChatMessageDriverConfiguration	true	none	none
messages	[ChatMessageMessage ]	true	none	none
output_schema	JsonSchema	true	none	none
tools	[ChatMessageTool ]	true	none	none

CreateChatMessageResponseContent

{
  "properties": {
    "content": {
      "items": {
        "properties": {
          "artifact": {
            "properties": {
              "id": {
                "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                "type": "string"
              },
              "meta": {},
              "name": {
                "type": "string"
              },
              "reference": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name",
              "type",
              "value"
            ],
            "type": "object"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "artifact",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "role": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "usage": {
      "properties": {
        "input_tokens": {
          "type": "number"
        },
        "output_tokens": {
          "type": "number"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "input_tokens",
        "output_tokens",
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "content",
    "role",
    "type",
    "usage"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
content	[MessageContent ]	true	none	none
role	string	true	none	none
type	string	true	none	none
usage	ChatMessageUsage	true	none	none

CreateChatMessageStreamRequestContent

{
  "properties": {
    "driver_configuration": {
      "properties": {
        "extra_params": {},
        "max_tokens": {
          "type": "number"
        },
        "model": {
          "type": "string"
        },
        "structured_output_strategy": {
          "type": "string"
        },
        "temperature": {
          "format": "float",
          "type": "number"
        },
        "use_native_tools": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "messages": {
      "items": {
        "properties": {
          "content": {
            "items": {
              "properties": {
                "artifact": {
                  "properties": {
                    "id": {
                      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                      "type": "string"
                    },
                    "meta": {},
                    "name": {
                      "type": "string"
                    },
                    "reference": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "type",
                    "value"
                  ],
                  "type": "object"
                },
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "artifact",
                "type"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "role": {
            "type": "string"
          },
          "usage": {
            "properties": {
              "input_tokens": {
                "type": "number"
              },
              "output_tokens": {
                "type": "number"
              },
              "type": {
                "type": "string"
              }
            },
            "required": [
              "input_tokens",
              "output_tokens",
              "type"
            ],
            "type": "object"
          }
        },
        "required": [
          "content",
          "role",
          "usage"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "output_schema": {
      "properties": {
        "additionalProperties": {
          "type": "boolean"
        },
        "description": {
          "type": "string"
        },
        "id": {
          "type": "string"
        },
        "properties": {
          "properties": {
            "member": {
              "properties": {
                "additionalProperties": {
                  "type": "boolean"
                },
                "description": {
                  "type": "string"
                },
                "properties": "[Circular]",
                "required": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "additionalProperties",
                "description",
                "properties",
                "required",
                "type"
              ],
              "type": "object"
            }
          },
          "type": "object"
        },
        "required": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "schema": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "additionalProperties",
        "description",
        "id",
        "properties",
        "required",
        "schema",
        "title",
        "type"
      ],
      "type": "object"
    },
    "tools": {
      "items": {
        "properties": {
          "activities": {
            "items": {
              "properties": {
                "description": {
                  "type": "string"
                },
                "json_schema": {
                  "properties": {
                    "additionalProperties": {
                      "type": "boolean"
                    },
                    "description": {
                      "type": "string"
                    },
                    "id": {
                      "type": "string"
                    },
                    "properties": {
                      "properties": {
                        "member": {
                          "properties": {
                            "additionalProperties": {
                              "type": "boolean"
                            },
                            "description": {
                              "type": "string"
                            },
                            "properties": "[Circular]",
                            "required": {
                              "items": {
                                "type": "string"
                              },
                              "type": "array"
                            },
                            "type": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "additionalProperties",
                            "description",
                            "properties",
                            "required",
                            "type"
                          ],
                          "type": "object"
                        }
                      },
                      "type": "object"
                    },
                    "required": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array"
                    },
                    "schema": {
                      "type": "string"
                    },
                    "title": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "additionalProperties",
                    "description",
                    "id",
                    "properties",
                    "required",
                    "schema",
                    "title",
                    "type"
                  ],
                  "type": "object"
                },
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "description",
                "json_schema",
                "name"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "activities",
          "name"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "driver_configuration",
    "messages",
    "output_schema",
    "tools"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
driver_configuration	ChatMessageDriverConfiguration	true	none	none
messages	[ChatMessageMessage ]	true	none	none
output_schema	JsonSchema	true	none	none
tools	[ChatMessageTool ]	true	none	none

CreateChatMessageStreamResponseContent

{
  "properties": {
    "content": {
      "items": {
        "properties": {
          "artifact": {
            "properties": {
              "id": {
                "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                "type": "string"
              },
              "meta": {},
              "name": {
                "type": "string"
              },
              "reference": {
                "type": "string"
              },
              "type": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "name",
              "type",
              "value"
            ],
            "type": "object"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "artifact",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "role": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "usage": {
      "properties": {
        "input_tokens": {
          "type": "number"
        },
        "output_tokens": {
          "type": "number"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "input_tokens",
        "output_tokens",
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "content",
    "role",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
content	[StreamMessageContent ]	true	none	none
role	string	true	none	none
type	string	true	none	none
usage	ChatMessageUsage	false	none	none

CreateCheckoutSessionRequestContent

{
  "properties": {
    "price_lookup_key": {
      "type": "string"
    }
  },
  "required": [
    "price_lookup_key"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
price_lookup_key	string	true	none	none

CreateCheckoutSessionResponseContent

{
  "properties": {
    "redirect_url": {
      "type": "string"
    }
  },
  "required": [
    "redirect_url"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
redirect_url	string	true	none	none

CreateConnectionRequestContent

{
  "properties": {
    "credentials": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "auth_code": {
                  "type": "string"
                }
              },
              "required": [
                "auth_code"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        }
      ]
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "type": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "credentials",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
credentials	ConnectionCredentialsInput	true	none	none
name	string	false	none	none
type	string	true	none	none

CreateConnectionResponseContent

{
  "properties": {
    "connection_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "connection_id",
    "created_at",
    "created_by",
    "name",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
config	DataConnectorConfigInputUnion	true	none	none
description	string	false	none	none
name	string	true	none	none
schedule_expression	string	false	none	none
transforms	[TransformInput ]	false	none	none
type	string	true	none	none

CreateDataConnectorResponseContent

{
  "properties": {
    "config": {
      "oneOf": [
        {
          "properties": {
            "confluence": {
              "properties": {
                "atlassian_email": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                }
              },
              "required": [
                "atlassian_email",
                "domain"
              ],
              "type": "object"
            }
          },
          "required": [
            "confluence"
          ],
          "title": "confluence",
          "type": "object"
        },
        {
          "properties": {
            "google_drive": {
              "properties": {
                "access_token": {
                  "type": "string"
                },
                "file_ids": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "access_token",
                "file_ids"
              ],
              "type": "object"
            }
          },
          "required": [
            "google_drive"
          ],
          "title": "google_drive",
          "type": "object"
        },
        {
          "properties": {
            "webscraper": {
              "properties": {
                "urls": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "urls"
              ],
              "type": "object"
            }
          },
          "required": [
            "webscraper"
          ],
          "title": "webscraper",
          "type": "object"
        },
        {
          "properties": {
            "structure": {
              "properties": {
                "args": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "structure_id": {
                  "type": "string"
                }
              },
              "required": [
                "structure_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "structure"
          ],
          "title": "structure",
          "type": "object"
        },
        {
          "properties": {
            "s3": {
              "properties": {
                "aws_access_key_id": {
                  "type": "string"
                },
                "uris": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "aws_access_key_id",
                "uris"
              ],
              "type": "object"
            }
          },
          "required": [
            "s3"
          ],
          "title": "s3",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_paths": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "bucket_id": {
                  "type": "string"
                }
              },
              "required": [
                "asset_paths",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "data_connector_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "data_job_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "schedule_expression": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "config",
    "created_at",
    "created_by",
    "data_connector_id",
    "name",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
config	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

{
  "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

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	none
status	DataJobStatus	true	none	none
status_detail	any	false	none	none

CreateEventsRequestContent

{
  "properties": {
    "events": {
      "items": {
        "properties": {
          "payload": {},
          "timestamp": {
            "format": "double",
            "type": "number"
          },
          "type": {
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          }
        },
        "required": [
          "timestamp",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
events	[EventInput ]	false	none	none

CreateFunctionDeploymentRequestContent

{
  "properties": {
    "code_source": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "access_token": {
                  "maxLength": 1000,
                  "minLength": 1,
                  "type": "string"
                },
                "commit_sha": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        }
      ]
    },
    "force": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code_source	CodeSourceInput	false	none	none
force	boolean	false	none	none

CreateFunctionDeploymentResponseContent

{
  "properties": {
    "code_source": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "commit_sha": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        }
      ]
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "function_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "status": {
      "enum": [
        "QUEUED",
        "DEPLOYING",
        "SUCCEEDED",
        "FAILED",
        "ERROR"
      ],
      "type": "string"
    },
    "status_detail": {}
  },
  "required": [
    "code_source",
    "created_at",
    "created_by",
    "deployment_id",
    "function_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code_source	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	DeploymentStatus	true	none	none
status_detail	any	false	none	none

CreateFunctionExecutionGetOutputPayload

{}

Properties

• None*

CreateFunctionExecutionPostInputPayload

{}

Properties

• None*

CreateFunctionExecutionPostOutputPayload

{}

Properties

• None*

CreateFunctionRequestContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "description": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "function_config_file": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	DataLakeFunctionCode	false	none	none
description	string	false	none	none
env_vars	[EnvVar ]	false	none	none
function_config_file	string	false	none	none
name	string	true	none	none

CreateFunctionResponseContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "function_config_file": {
      "type": "string"
    },
    "function_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "latest_deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "code",
    "created_at",
    "created_by",
    "description",
    "env_vars",
    "function_id",
    "latest_deployment_id",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	false	none	none
config	IntegrationConfigInputUnion	true	none	none
description	string	false	none	none
name	string	true	none	none
structure_ids	[string]	false	none	none
type	IntegrationType	true	none	none

CreateIntegrationResponseContent

{
  "properties": {
    "assistant_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "config": {
      "oneOf": [
        {
          "properties": {
            "slack": {
              "properties": {
                "app_description": {
                  "type": "string"
                },
                "app_display_name": {
                  "type": "string"
                },
                "app_manifest": {},
                "app_name": {
                  "type": "string"
                },
                "bot_token_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                },
                "signing_secret_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "app_description",
                "app_display_name",
                "app_manifest",
                "app_name",
                "bot_token_secret_ref",
                "signing_secret_secret_ref"
              ],
              "type": "object"
            }
          },
          "required": [
            "slack"
          ],
          "title": "slack",
          "type": "object"
        },
        {
          "properties": {
            "github_app": {
              "properties": {
                "app_id": {
                  "type": "string"
                },
                "integration_endpoint": {
                  "type": "string"
                },
                "private_key_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                },
                "webhook_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "app_id",
                "integration_endpoint",
                "private_key_secret_ref",
                "webhook_secret_ref"
              ],
              "type": "object"
            }
          },
          "required": [
            "github_app"
          ],
          "title": "github_app",
          "type": "object"
        },
        {
          "properties": {
            "webhook": {
              "properties": {
                "disable_api_key_param": {
                  "type": "boolean"
                },
                "integration_endpoint": {
                  "type": "string"
                }
              },
              "required": [
                "disable_api_key_param",
                "integration_endpoint"
              ],
              "type": "object"
            }
          },
          "required": [
            "webhook"
          ],
          "title": "webhook",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "integration_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "enum": [
        "slack",
        "github_app",
        "webhook"
      ],
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "assistant_ids",
    "config",
    "created_at",
    "created_by",
    "description",
    "integration_id",
    "name",
    "organization_id",
    "structure_ids",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	true	none	none
config	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	IntegrationType	true	none	none
updated_at	string(date-time)	true	none	none

CreateInviteRequestContent

{
  "properties": {
    "email": {
      "maxLength": 254,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "email"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
email	string	true	none	none

CreateInviteResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "expires_at": {
      "format": "date-time",
      "type": "string"
    },
    "invite_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "responded_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "ACCEPTED",
        "EXPIRED",
        "PENDING",
        "REJECTED"
      ],
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "email",
    "expires_at",
    "invite_id",
    "organization_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	InviteStatus	true	none	none

CreateKnowledgeBaseJobResponseContent

{
  "properties": {
    "bytes_ingested": {
      "type": "number"
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "errors": {
      "items": {
        "properties": {
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "knowledge_base_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "knowledge_base_job_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "status": {
      "enum": [
        "QUEUED",
        "RUNNING",
        "SUCCEEDED",
        "FAILED",
        "CANCELLED"
      ],
      "type": "string"
    },
    "status_detail": {}
  },
  "required": [
    "created_at",
    "created_by",
    "knowledge_base_id",
    "knowledge_base_job_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	none
knowledge_base_id	string	true	none	none
knowledge_base_job_id	string	true	none	none
status	KnowledgeBaseJobStatus	true	none	none
status_detail	any	false	none	none

CreateKnowledgeBaseRequestContent

{
  "properties": {
    "asset_paths": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "config": {
      "oneOf": [
        {
          "properties": {
            "pg_vector": {
              "properties": {
                "connection_string": {
                  "type": "string"
                },
                "embedding_model": {
                  "type": "string"
                },
                "password": {
                  "type": "string"
                },
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "connection_string",
                "password"
              ],
              "type": "object"
            }
          },
          "required": [
            "pg_vector"
          ],
          "title": "pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "gtc_pg_vector": {
              "properties": {
                "embedding_model": {
                  "type": "string"
                },
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "gtc_pg_vector"
          ],
          "title": "gtc_pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "gtc_hybrid_sql_pg_vector": {
              "properties": {
                "embedding_model": {
                  "type": "string"
                },
                "structured_columns": {
                  "items": {
                    "properties": {
                      "column_name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "sql_type": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "column_name",
                      "description",
                      "sql_type"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "unstructured_columns": {
                  "items": {
                    "properties": {
                      "column_name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "column_name",
                      "description"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "structured_columns",
                "unstructured_columns"
              ],
              "type": "object"
            }
          },
          "required": [
            "gtc_hybrid_sql_pg_vector"
          ],
          "title": "gtc_hybrid_sql_pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "pgai_knowledge_base": {
              "type": "object"
            }
          },
          "required": [
            "pgai_knowledge_base"
          ],
          "title": "pgai_knowledge_base",
          "type": "object"
        }
      ]
    },
    "description": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "embedding_model": {
      "enum": [
        "text-embedding-ada-002",
        "text-embedding-3-small"
      ],
      "type": "string"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "transforms": {
      "items": {
        "properties": {
          "structure": {
            "properties": {
              "args": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "structure_id": {
                "type": "string"
              }
            },
            "required": [
              "structure_id"
            ],
            "type": "object"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "required": [
    "config",
    "name",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
asset_paths	[string]	false	none	none
config	KnowledgeBaseConfigInputUnion	true	none	none
description	string	false	none	none
embedding_model	EmbeddingModel	false	none	none
name	string	true	none	none
transforms	[TransformDetail ]	false	none	none
type	string	true	none	none
use_default_embedding_model	boolean	false	none	none

CreateKnowledgeBaseResponseContent

{
  "properties": {
    "asset_paths": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "config": {
      "oneOf": [
        {
          "properties": {
            "pg_vector": {
              "properties": {
                "connection_string": {
                  "type": "string"
                },
                "embedding_model": {
                  "type": "string"
                },
                "query_schema": {},
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "connection_string",
                "embedding_model",
                "query_schema",
                "use_default_embedding_model"
              ],
              "type": "object"
            }
          },
          "required": [
            "pg_vector"
          ],
          "title": "pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "gtc_pg_vector": {
              "properties": {
                "embedding_model": {
                  "type": "string"
                },
                "query_schema": {},
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "embedding_model",
                "query_schema",
                "use_default_embedding_model"
              ],
              "type": "object"
            }
          },
          "required": [
            "gtc_pg_vector"
          ],
          "title": "gtc_pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "gtc_hybrid_sql_pg_vector": {
              "properties": {
                "embedding_model": {
                  "type": "string"
                },
                "query_schema": {},
                "structured_columns": {
                  "items": {
                    "properties": {
                      "column_name": {
                        "type": "string"
                      },
                      "sql_type": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "column_name",
                      "sql_type"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "unstructured_columns": {
                  "items": {
                    "properties": {
                      "column_name": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "column_name"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "embedding_model",
                "query_schema",
                "structured_columns",
                "unstructured_columns",
                "use_default_embedding_model"
              ],
              "type": "object"
            }
          },
          "required": [
            "gtc_hybrid_sql_pg_vector"
          ],
          "title": "gtc_hybrid_sql_pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "pgai_knowledge_base": {
              "properties": {
                "knowledge_base_name": {
                  "type": "string"
                },
                "query_schema": {}
              },
              "required": [
                "knowledge_base_name",
                "query_schema"
              ],
              "type": "object"
            }
          },
          "required": [
            "pgai_knowledge_base"
          ],
          "title": "pgai_knowledge_base",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "embedding_model": {
      "enum": [
        "text-embedding-ada-002",
        "text-embedding-3-small"
      ],
      "type": "string"
    },
    "knowledge_base_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "schedule_expression": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "transforms": {
      "items": {
        "properties": {
          "structure": {
            "properties": {
              "args": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "structure_id": {
                "type": "string"
              }
            },
            "required": [
              "structure_id"
            ],
            "type": "object"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "required": [
    "asset_paths",
    "config",
    "created_at",
    "created_by",
    "knowledge_base_id",
    "name",
    "organization_id",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
asset_paths	[string]	true	none	none
config	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	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
data_connector_ids	[string]	true	none	none
description	string	false	none	none
knowledge_base_configs	[KnowledgeBaseConfigInputUnion ]	true	none	none
name	string	true	none	none

CreateLibraryResponseContent

{
  "properties": {
    "assistant_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "data_connector_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "description": {
      "type": "string"
    },
    "knowledge_base_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "library_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "retriever_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "assistant_id",
    "created_at",
    "created_by",
    "data_connector_ids",
    "knowledge_base_ids",
    "library_id",
    "name",
    "organization_id",
    "retriever_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "input": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    }
  },
  "required": [
    "input",
    "output"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
input	string	true	none	none
metadata	Metadata	false	none	none
output	string	true	none	none

CreateMessageResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "index": {
      "type": "number"
    },
    "input": {
      "type": "string"
    },
    "message_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    },
    "thread_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "index",
    "input",
    "message_id",
    "metadata",
    "output",
    "thread_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	Metadata	true	none	none
output	string	true	none	none
thread_id	string	true	none	none
updated_at	string(date-time)	true	none	none

CreateOrganizationApiKeyRequestContent

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none

CreateOrganizationApiKeyResponseContent

{
  "properties": {
    "active": {
      "type": "boolean"
    },
    "api_key_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "last_used": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "active",
    "api_key_id",
    "created_at",
    "created_by",
    "last_used",
    "name",
    "organization_id",
    "updated_at",
    "value"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "description": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
description	string	false	none	none
name	string	true	none	none

CreateOrganizationResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "default_bucket_id": {
      "type": "string"
    },
    "description": {
      "maxLength": 2000,
      "type": "string"
    },
    "entitlement": {
      "allOf": [
        {
          "enum": [
            "FREE",
            "PAID",
            "PARTNER",
            "UNPAID",
            "EXPIRED"
          ],
          "type": "string"
        },
        {
          "default": "FREE"
        }
      ]
    },
    "model_config": {
      "properties": {
        "default_chat_model": {
          "type": "string"
        },
        "default_embedding_model": {
          "type": "string"
        },
        "default_image_generation_model": {
          "type": "string"
        },
        "default_rerank_model": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "default_bucket_id",
    "description",
    "entitlement",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

Name	Type	Required	Restrictions	Description
» anonymous	Entitlement	false	none	none

and

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

continued

Name	Type	Required	Restrictions	Description
model_config	OrganizationModelConfig	false	none	none
name	string	true	none	none
organization_id	string	true	none	none
updated_at	string(date-time)	true	none	none

CreateRetrieverComponentRequestContent

{
  "properties": {
    "config": {},
    "description": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "config",
    "name",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
config	any	true	none	none
description	string	false	none	none
name	string	true	none	none
type	string	true	none	none

CreateRetrieverComponentResponseContent

{
  "properties": {
    "config": {},
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "retriever_component_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "config",
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "retriever_component_id",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
description	string	false	none	none
name	string	true	none	none
retriever_component_ids	[string]	false	none	none
retriever_components	[RetrieverComponentInput ]	false	none	none

CreateRetrieverResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "retriever_components": {
      "items": {
        "properties": {
          "config": {},
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "retriever_component_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "config",
          "created_at",
          "created_by",
          "name",
          "organization_id",
          "retriever_component_id",
          "type",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "retriever_components_schema": {},
    "retriever_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "retriever_components",
    "retriever_components_schema",
    "retriever_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[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

{
  "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

Name	Type	Required	Restrictions	Description
metadata	Metadata	false	none	none
name	string	true	none	none
rule	string	true	none	none

CreateRuleResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "rule": {
      "type": "string"
    },
    "rule_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "metadata",
    "name",
    "organization_id",
    "rule",
    "rule_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
metadata	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

{
  "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

Name	Type	Required	Restrictions	Description
alias	string	false	none	none
description	string	false	none	none
metadata	Metadata	false	none	none
name	string	true	none	none
rule_ids	[string]	false	none	none

CreateRulesetResponseContent

{
  "properties": {
    "alias": {
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "rule_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "ruleset_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "alias",
    "created_at",
    "created_by",
    "description",
    "metadata",
    "name",
    "organization_id",
    "rule_ids",
    "ruleset_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "value": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name",
    "value"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
value	string	true	none	none

CreateSecretResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "last_used": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "secret_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "last_used",
    "name",
    "organization_id",
    "secret_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
code_source	CodeSourceInput	false	none	none
force	boolean	false	none	none

CreateStructureDeploymentResponseContent

{
  "properties": {
    "code_source": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "commit_sha": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        }
      ]
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "status": {
      "enum": [
        "QUEUED",
        "DEPLOYING",
        "SUCCEEDED",
        "FAILED",
        "ERROR"
      ],
      "type": "string"
    },
    "status_detail": {},
    "structure_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    }
  },
  "required": [
    "code_source",
    "created_at",
    "created_by",
    "deployment_id",
    "status",
    "structure_id"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code_source	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	DeploymentStatus	true	none	none
status_detail	any	false	none	none
structure_id	string	true	none	none

CreateStructureRequestContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "description": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "structure_config_file": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "webhook_enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	DataLakeStructureCode	false	none	none
description	string	false	none	none
env_vars	[EnvVar ]	false	none	none
name	string	true	none	none
structure_config_file	string	false	none	none
webhook_enabled	boolean	false	none	none

CreateStructureResponseContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "latest_deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_config_file": {
      "type": "string"
    },
    "structure_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "webhook_enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "code",
    "created_at",
    "created_by",
    "description",
    "env_vars",
    "latest_deployment_id",
    "name",
    "organization_id",
    "structure_id",
    "updated_at",
    "webhook_enabled"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
args	[string]	true	none	none
env_vars	[EnvVar ]	false	none	none

CreateStructureRunResponseContent

{
  "properties": {
    "args": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "output": {},
    "output_timestamp": {
      "format": "double",
      "type": "number"
    },
    "started_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "status": {
      "enum": [
        "QUEUED",
        "STARTING",
        "RUNNING",
        "SUCCEEDED",
        "FAILED",
        "ERROR",
        "CANCELLED"
      ],
      "type": "string"
    },
    "status_detail": {},
    "structure_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_run_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "args",
    "completed_at",
    "created_at",
    "created_by",
    "started_at",
    "status",
    "structure_id",
    "structure_run_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[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	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

{
  "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

Name	Type	Required	Restrictions	Description
alias	string	false	none	none
messages	[MessageInput ]	false	none	none
metadata	Metadata	false	none	none
name	string	true	none	none

CreateThreadResponseContent

{
  "properties": {
    "alias": {
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "thread_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "alias",
    "created_at",
    "created_by",
    "metadata",
    "name",
    "organization_id",
    "thread_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
alias	string	true	none	none
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
metadata	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

{}

Properties

• None*

CreateToolActivityRunOutputPayload

{}

Properties

• None*

CreateToolDeploymentRequestContent

{
  "properties": {
    "code_source": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "access_token": {
                  "maxLength": 1000,
                  "minLength": 1,
                  "type": "string"
                },
                "commit_sha": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        }
      ]
    },
    "force": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code_source	CodeSourceInput	false	none	none
force	boolean	false	none	none

CreateToolDeploymentResponseContent

{
  "properties": {
    "code_source": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "commit_sha": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        }
      ]
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "status": {
      "enum": [
        "QUEUED",
        "DEPLOYING",
        "SUCCEEDED",
        "FAILED",
        "ERROR"
      ],
      "type": "string"
    },
    "status_detail": {},
    "tool_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    }
  },
  "required": [
    "code_source",
    "created_at",
    "created_by",
    "deployment_id",
    "status",
    "tool_id"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code_source	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	DeploymentStatus	true	none	none
status_detail	any	false	none	none
tool_id	string	true	none	none

CreateToolRequestContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "description": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "tool_config_file": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	DataLakeToolCode	false	none	none
description	string	false	none	none
env_vars	[EnvVar ]	false	none	none
name	string	true	none	none
tool_config_file	string	false	none	none

CreateToolResponseContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "latest_deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "tool_config_file": {
      "type": "string"
    },
    "tool_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "code",
    "created_at",
    "created_by",
    "description",
    "env_vars",
    "latest_deployment_id",
    "name",
    "organization_id",
    "tool_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "oneOf": [
    {
      "properties": {
        "confluence": {
          "properties": {
            "atlassian_api_token": {
              "type": "string"
            },
            "atlassian_email": {
              "type": "string"
            },
            "domain": {
              "type": "string"
            }
          },
          "required": [
            "atlassian_api_token",
            "atlassian_email",
            "domain"
          ],
          "type": "object"
        }
      },
      "required": [
        "confluence"
      ],
      "title": "confluence",
      "type": "object"
    },
    {
      "properties": {
        "google_drive": {
          "properties": {
            "auth_code": {
              "type": "string"
            },
            "file_ids": {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "auth_code",
            "file_ids"
          ],
          "type": "object"
        }
      },
      "required": [
        "google_drive"
      ],
      "title": "google_drive",
      "type": "object"
    },
    {
      "properties": {
        "webscraper": {
          "properties": {
            "urls": {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "urls"
          ],
          "type": "object"
        }
      },
      "required": [
        "webscraper"
      ],
      "title": "webscraper",
      "type": "object"
    },
    {
      "properties": {
        "structure": {
          "properties": {
            "args": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "structure_id": {
              "type": "string"
            }
          },
          "required": [
            "structure_id"
          ],
          "type": "object"
        }
      },
      "required": [
        "structure"
      ],
      "title": "structure",
      "type": "object"
    },
    {
      "properties": {
        "s3": {
          "properties": {
            "aws_access_key_id": {
              "type": "string"
            },
            "aws_secret_access_key": {
              "type": "string"
            },
            "uris": {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "aws_access_key_id",
            "aws_secret_access_key",
            "uris"
          ],
          "type": "object"
        }
      },
      "required": [
        "s3"
      ],
      "title": "s3",
      "type": "object"
    },
    {
      "properties": {
        "data_lake": {
          "properties": {
            "asset_paths": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "bucket_id": {
              "type": "string"
            }
          },
          "required": [
            "bucket_id"
          ],
          "type": "object"
        }
      },
      "required": [
        "data_lake"
      ],
      "title": "data_lake",
      "type": "object"
    }
  ]
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» confluence	ConfluenceInput	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» google_drive	GoogleDriveInput	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» webscraper	WebscraperInput	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» structure	StructureConnectorInput	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» s3	S3ConnectorInput	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data_lake	DataLakeConnectorInput	true	none	none

DataConnectorConfigUnion

{
  "oneOf": [
    {
      "properties": {
        "confluence": {
          "properties": {
            "atlassian_email": {
              "type": "string"
            },
            "domain": {
              "type": "string"
            }
          },
          "required": [
            "atlassian_email",
            "domain"
          ],
          "type": "object"
        }
      },
      "required": [
        "confluence"
      ],
      "title": "confluence",
      "type": "object"
    },
    {
      "properties": {
        "google_drive": {
          "properties": {
            "access_token": {
              "type": "string"
            },
            "file_ids": {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "access_token",
            "file_ids"
          ],
          "type": "object"
        }
      },
      "required": [
        "google_drive"
      ],
      "title": "google_drive",
      "type": "object"
    },
    {
      "properties": {
        "webscraper": {
          "properties": {
            "urls": {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "urls"
          ],
          "type": "object"
        }
      },
      "required": [
        "webscraper"
      ],
      "title": "webscraper",
      "type": "object"
    },
    {
      "properties": {
        "structure": {
          "properties": {
            "args": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "structure_id": {
              "type": "string"
            }
          },
          "required": [
            "structure_id"
          ],
          "type": "object"
        }
      },
      "required": [
        "structure"
      ],
      "title": "structure",
      "type": "object"
    },
    {
      "properties": {
        "s3": {
          "properties": {
            "aws_access_key_id": {
              "type": "string"
            },
            "uris": {
              "items": {
                "type": "string"
              },
              "type": "array"
            }
          },
          "required": [
            "aws_access_key_id",
            "uris"
          ],
          "type": "object"
        }
      },
      "required": [
        "s3"
      ],
      "title": "s3",
      "type": "object"
    },
    {
      "properties": {
        "data_lake": {
          "properties": {
            "asset_paths": {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            "bucket_id": {
              "type": "string"
            }
          },
          "required": [
            "asset_paths",
            "bucket_id"
          ],
          "type": "object"
        }
      },
      "required": [
        "data_lake"
      ],
      "title": "data_lake",
      "type": "object"
    }
  ]
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» confluence	ConfluenceDetail	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» google_drive	GoogleDriveDetail	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» webscraper	WebscraperDetail	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» structure	StructureConnectorDetail	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» s3	S3ConnectorDetail	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data_lake	DataLakeConnectorDetail	true	none	none

DataConnectorDetail

{
  "properties": {
    "bucket_id": {
      "type": "string"
    },
    "config": {
      "oneOf": [
        {
          "properties": {
            "confluence": {
              "properties": {
                "atlassian_email": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                }
              },
              "required": [
                "atlassian_email",
                "domain"
              ],
              "type": "object"
            }
          },
          "required": [
            "confluence"
          ],
          "title": "confluence",
          "type": "object"
        },
        {
          "properties": {
            "google_drive": {
              "properties": {
                "access_token": {
                  "type": "string"
                },
                "file_ids": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "access_token",
                "file_ids"
              ],
              "type": "object"
            }
          },
          "required": [
            "google_drive"
          ],
          "title": "google_drive",
          "type": "object"
        },
        {
          "properties": {
            "webscraper": {
              "properties": {
                "urls": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "urls"
              ],
              "type": "object"
            }
          },
          "required": [
            "webscraper"
          ],
          "title": "webscraper",
          "type": "object"
        },
        {
          "properties": {
            "structure": {
              "properties": {
                "args": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "structure_id": {
                  "type": "string"
                }
              },
              "required": [
                "structure_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "structure"
          ],
          "title": "structure",
          "type": "object"
        },
        {
          "properties": {
            "s3": {
              "properties": {
                "aws_access_key_id": {
                  "type": "string"
                },
                "uris": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "aws_access_key_id",
                "uris"
              ],
              "type": "object"
            }
          },
          "required": [
            "s3"
          ],
          "title": "s3",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_paths": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "bucket_id": {
                  "type": "string"
                }
              },
              "required": [
                "asset_paths",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "data_connector_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "schedule_expression": {
      "type": "string"
    },
    "transforms": {
      "items": {
        "properties": {
          "structure": {
            "properties": {
              "args": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "structure_id": {
                "type": "string"
              }
            },
            "required": [
              "structure_id"
            ],
            "type": "object"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "config",
    "created_at",
    "created_by",
    "data_connector_id",
    "name",
    "organization_id",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
bucket_id	string	false	none	none
config	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	[TransformDetail ]	false	none	none
type	string	true	none	none
updated_at	string(date-time)	true	none	none

DataJobDetail

{
  "properties": {
    "bytes_ingested": {
      "type": "number"
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "data_connector_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "data_job_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "errors": {
      "items": {
        "properties": {
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "status": {
      "enum": [
        "QUEUED",
        "RUNNING",
        "SUCCEEDED",
        "FAILED",
        "CANCELLED"
      ],
      "type": "string"
    },
    "status_detail": {}
  },
  "required": [
    "created_at",
    "created_by",
    "data_connector_id",
    "data_job_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	none
status	DataJobStatus	true	none	none
status_detail	any	false	none	none

DataJobStatus

{
  "enum": [
    "QUEUED",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "CANCELLED"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	QUEUED
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	CANCELLED

DataLakeCodeSource

{
  "properties": {
    "asset_path": {
      "type": "string"
    },
    "bucket_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    }
  },
  "required": [
    "asset_path",
    "bucket_id"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
asset_path	string	true	none	none
bucket_id	string	true	none	none

DataLakeConnectorDetail

{
  "properties": {
    "asset_paths": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "bucket_id": {
      "type": "string"
    }
  },
  "required": [
    "asset_paths",
    "bucket_id"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
asset_paths	[string]	true	none	none
bucket_id	string	true	none	none

DataLakeConnectorInput

{
  "properties": {
    "asset_paths": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "bucket_id": {
      "type": "string"
    }
  },
  "required": [
    "bucket_id"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
asset_paths	[string]	false	none	none
bucket_id	string	true	none	none

DataLakeFunctionCode

{
  "properties": {
    "asset_path": {
      "type": "string"
    },
    "bucket_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    }
  },
  "required": [
    "asset_path",
    "bucket_id"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
asset_path	string	true	none	none
bucket_id	string	true	none	none

DataLakeStructureCode

{
  "properties": {
    "asset_path": {
      "type": "string"
    },
    "bucket_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    }
  },
  "required": [
    "asset_path",
    "bucket_id"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
asset_path	string	true	none	none
bucket_id	string	true	none	none

DataLakeToolCode

{
  "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

Name	Type	Required	Restrictions	Description
asset_path	string	true	none	none
bucket_id	string	true	none	none

DefaultFunctionCode

{
  "type": "object"
}

Properties

• None*

DefaultStructureCode

{
  "type": "object"
}

Properties

• None*

DefaultToolCode

{
  "type": "object"
}

Properties

• None*

DeploymentCountGauge

{
  "properties": {
    "active_count": {
      "type": "number"
    },
    "total_count": {
      "type": "number"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
active_count	number	false	none	none
total_count	number	false	none	none

DeploymentDurationGauge

{
  "properties": {
    "total_seconds": {
      "type": "number"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
total_seconds	number	false	none	none

DeploymentErrorRateGauge

{
  "properties": {
    "rate": {
      "format": "float",
      "type": "number"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
rate	number(float)	false	none	none

DeploymentStatus

{
  "enum": [
    "QUEUED",
    "DEPLOYING",
    "SUCCEEDED",
    "FAILED",
    "ERROR"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	QUEUED
anonymous	DEPLOYING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	ERROR

DurationPlot

{
  "properties": {
    "seconds_avg": {
      "type": "number"
    },
    "seconds_p100": {
      "type": "number"
    },
    "seconds_p50": {
      "type": "number"
    },
    "timeseries": {
      "items": {
        "properties": {
          "seconds_p0": {
            "type": "number"
          },
          "seconds_p100": {
            "type": "number"
          },
          "seconds_p50": {
            "type": "number"
          },
          "time": {
            "format": "date-time",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
seconds_avg	number	false	none	none
seconds_p100	number	false	none	none
seconds_p50	number	false	none	none
timeseries	[DurationTimeseriesElement ]	false	none	none

DurationTimeseriesElement

{
  "properties": {
    "seconds_p0": {
      "type": "number"
    },
    "seconds_p100": {
      "type": "number"
    },
    "seconds_p50": {
      "type": "number"
    },
    "time": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "enum": [
    "text-embedding-ada-002",
    "text-embedding-3-small"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	text-embedding-ada-002
anonymous	text-embedding-3-small

Entitlement

{
  "enum": [
    "FREE",
    "PAID",
    "PARTNER",
    "UNPAID",
    "EXPIRED"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	FREE
anonymous	PAID
anonymous	PARTNER
anonymous	UNPAID
anonymous	EXPIRED

Entry

{
  "properties": {
    "id": {
      "type": "string"
    },
    "meta": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "namespace": {
      "type": "string"
    },
    "score": {
      "format": "float",
      "type": "number"
    },
    "vector": {
      "items": {
        "format": "float",
        "type": "number"
      },
      "type": "array"
    }
  },
  "required": [
    "id",
    "score"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	true	none	none
meta	Meta	false	none	none
namespace	string	false	none	none
score	number(float)	true	none	none
vector	[number]	false	none	none

EnvVar

{
  "properties": {
    "name": {
      "type": "string"
    },
    "source": {
      "enum": [
        "secret_ref",
        "manual"
      ],
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "value"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
source	EnvVarSource	false	none	none
value	string	true	none	none

EnvVarSource

{
  "enum": [
    "secret_ref",
    "manual"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	secret_ref
anonymous	manual

Error

{
  "properties": {
    "message": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "message",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
message	string	true	none	none
path	string	false	none	none
type	string	true	none	none

ErrorRateGauge

{
  "properties": {
    "error_type_counts": {
      "items": {
        "properties": {
          "count": {
            "type": "number"
          },
          "error_type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "rate": {
      "format": "float",
      "type": "number"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
error_type_counts	[ErrorTypeCount ]	false	none	none
rate	number(float)	false	none	none

ErrorTypeCount

{
  "properties": {
    "count": {
      "type": "number"
    },
    "error_type": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
count	number	false	none	none
error_type	string	false	none	none

EventDetail

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "event_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "origin": {
      "type": "string"
    },
    "payload": {},
    "structure_run_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "timestamp": {
      "format": "double",
      "type": "number"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "event_id",
    "origin",
    "payload",
    "structure_run_id",
    "timestamp",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "payload": {},
    "timestamp": {
      "format": "double",
      "type": "number"
    },
    "type": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "timestamp",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
payload	any	false	none	none
timestamp	number(double)	true	none	none
type	string	true	none	none

FunctionCode

{
  "oneOf": [
    {
      "properties": {
        "github": {
          "properties": {
            "name": {
              "maxLength": 200,
              "minLength": 1,
              "type": "string"
            },
            "owner": {
              "maxLength": 200,
              "minLength": 1,
              "type": "string"
            },
            "push": {
              "properties": {
                "branch": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "tag": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "branch"
              ],
              "type": "object"
            }
          },
          "required": [
            "name",
            "owner",
            "push"
          ],
          "type": "object"
        }
      },
      "required": [
        "github"
      ],
      "title": "github",
      "type": "object"
    },
    {
      "properties": {
        "data_lake": {
          "properties": {
            "asset_path": {
              "type": "string"
            },
            "bucket_id": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            }
          },
          "required": [
            "asset_path",
            "bucket_id"
          ],
          "type": "object"
        }
      },
      "required": [
        "data_lake"
      ],
      "title": "data_lake",
      "type": "object"
    },
    {
      "properties": {
        "default": {
          "type": "object"
        }
      },
      "required": [
        "default"
      ],
      "title": "default",
      "type": "object"
    }
  ]
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» github	GithubFunctionCode	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data_lake	DataLakeFunctionCode	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» default	DefaultFunctionCode	true	none	none

FunctionDeploymentDetail

{
  "properties": {
    "code_source": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "commit_sha": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        }
      ]
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "function_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "status": {
      "enum": [
        "QUEUED",
        "DEPLOYING",
        "SUCCEEDED",
        "FAILED",
        "ERROR"
      ],
      "type": "string"
    },
    "status_detail": {}
  },
  "required": [
    "code_source",
    "created_at",
    "created_by",
    "deployment_id",
    "function_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code_source	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	DeploymentStatus	true	none	none
status_detail	any	false	none	none

FunctionDetail

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "function_config_file": {
      "type": "string"
    },
    "function_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "latest_deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "code",
    "created_at",
    "created_by",
    "description",
    "env_vars",
    "function_id",
    "latest_deployment_id",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
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	[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	FunctionRunStatus	true	none	none
status_detail	any	false	none	none
updated_at	string(date-time)	true	none	none

FunctionRunStatus

{
  "enum": [
    "QUEUED",
    "STARTING",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	QUEUED
anonymous	STARTING
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	ERROR
anonymous	CANCELLED

GTCHybidSQLPGVectorKnowledgeBaseDetail

{
  "properties": {
    "embedding_model": {
      "type": "string"
    },
    "query_schema": {},
    "structured_columns": {
      "items": {
        "properties": {
          "column_name": {
            "type": "string"
          },
          "sql_type": {
            "type": "string"
          }
        },
        "required": [
          "column_name",
          "sql_type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "unstructured_columns": {
      "items": {
        "properties": {
          "column_name": {
            "type": "string"
          }
        },
        "required": [
          "column_name"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "required": [
    "embedding_model",
    "query_schema",
    "structured_columns",
    "unstructured_columns",
    "use_default_embedding_model"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
embedding_model	string	true	none	none
query_schema	any	true	none	none
structured_columns	[StructuredColumnDetail ]	true	none	none
unstructured_columns	[UnstructuredColumnDetail ]	true	none	none
use_default_embedding_model	boolean	true	none	none

GTCHybidSQLPGVectorKnowledgeBaseInput

{
  "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

Name	Type	Required	Restrictions	Description
embedding_model	string	false	none	none
structured_columns	[StructuredColumnInput ]	true	none	none
unstructured_columns	[UnstructuredColumnInput ]	true	none	none
use_default_embedding_model	boolean	false	none	none

GTCPGVectorKnowledgeBaseDetail

{
  "properties": {
    "embedding_model": {
      "type": "string"
    },
    "query_schema": {},
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "required": [
    "embedding_model",
    "query_schema",
    "use_default_embedding_model"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
embedding_model	string	true	none	none
query_schema	any	true	none	none
use_default_embedding_model	boolean	true	none	none

GTCPGVectorKnowledgeBaseInput

{
  "properties": {
    "embedding_model": {
      "type": "string"
    },
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
embedding_model	string	false	none	none
use_default_embedding_model	boolean	false	none	none

GetApiKeyResponseContent

{
  "properties": {
    "active": {
      "type": "boolean"
    },
    "api_key_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "last_used": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "active",
    "api_key_id",
    "created_at",
    "created_by",
    "last_used",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "format": "byte",
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string(byte)	false	none	none

GetAssistantRunResponseContent

{
  "properties": {
    "args": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "assistant_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "assistant_run_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "input": {
      "type": "string"
    },
    "knowledge_base_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "output": {},
    "retriever_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "ruleset_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "status": {
      "enum": [
        "QUEUED",
        "STARTING",
        "RUNNING",
        "SUCCEEDED",
        "FAILED",
        "ERROR",
        "CANCELLED"
      ],
      "type": "string"
    },
    "status_detail": {},
    "stream": {
      "type": "boolean"
    },
    "structure_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "thread_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "tool_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "args",
    "assistant_id",
    "assistant_run_id",
    "completed_at",
    "created_at",
    "created_by",
    "knowledge_base_ids",
    "retriever_ids",
    "ruleset_ids",
    "status",
    "stream",
    "structure_ids",
    "tool_ids",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
bucket_id	string	false	none	none
config	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	[TransformDetail ]	false	none	none
type	string	true	none	none
updated_at	string(date-time)	true	none	none

GetDataJobResponseContent

{
  "properties": {
    "bytes_ingested": {
      "type": "number"
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "data_connector_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "data_job_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "errors": {
      "items": {
        "properties": {
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "status": {
      "enum": [
        "QUEUED",
        "RUNNING",
        "SUCCEEDED",
        "FAILED",
        "CANCELLED"
      ],
      "type": "string"
    },
    "status_detail": {}
  },
  "required": [
    "created_at",
    "created_by",
    "data_connector_id",
    "data_job_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	none
status	DataJobStatus	true	none	none
status_detail	any	false	none	none

GetDeploymentResponseContent

{
  "properties": {
    "code_source": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "commit_sha": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        }
      ]
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "function_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "status": {
      "enum": [
        "QUEUED",
        "DEPLOYING",
        "SUCCEEDED",
        "FAILED",
        "ERROR"
      ],
      "type": "string"
    },
    "status_detail": {},
    "structure_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "tool_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    }
  },
  "required": [
    "code_source",
    "created_at",
    "created_by",
    "deployment_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code_source	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	DeploymentStatus	true	none	none
status_detail	any	false	none	none
structure_id	string	false	none	none
tool_id	string	false	none	none

GetEventResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "event_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "origin": {
      "type": "string"
    },
    "payload": {},
    "structure_run_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "timestamp": {
      "format": "double",
      "type": "number"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "event_id",
    "origin",
    "payload",
    "structure_run_id",
    "timestamp",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
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	[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	FunctionRunStatus	true	none	none
status_detail	any	false	none	none
updated_at	string(date-time)	true	none	none

GetIntegrationResponseContent

{
  "properties": {
    "assistant_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "config": {
      "oneOf": [
        {
          "properties": {
            "slack": {
              "properties": {
                "app_description": {
                  "type": "string"
                },
                "app_display_name": {
                  "type": "string"
                },
                "app_manifest": {},
                "app_name": {
                  "type": "string"
                },
                "bot_token_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                },
                "signing_secret_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "app_description",
                "app_display_name",
                "app_manifest",
                "app_name",
                "bot_token_secret_ref",
                "signing_secret_secret_ref"
              ],
              "type": "object"
            }
          },
          "required": [
            "slack"
          ],
          "title": "slack",
          "type": "object"
        },
        {
          "properties": {
            "github_app": {
              "properties": {
                "app_id": {
                  "type": "string"
                },
                "integration_endpoint": {
                  "type": "string"
                },
                "private_key_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                },
                "webhook_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "app_id",
                "integration_endpoint",
                "private_key_secret_ref",
                "webhook_secret_ref"
              ],
              "type": "object"
            }
          },
          "required": [
            "github_app"
          ],
          "title": "github_app",
          "type": "object"
        },
        {
          "properties": {
            "webhook": {
              "properties": {
                "disable_api_key_param": {
                  "type": "boolean"
                },
                "integration_endpoint": {
                  "type": "string"
                }
              },
              "required": [
                "disable_api_key_param",
                "integration_endpoint"
              ],
              "type": "object"
            }
          },
          "required": [
            "webhook"
          ],
          "title": "webhook",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "integration_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "enum": [
        "slack",
        "github_app",
        "webhook"
      ],
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "assistant_ids",
    "config",
    "created_at",
    "created_by",
    "description",
    "integration_id",
    "name",
    "organization_id",
    "structure_ids",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	true	none	none
config	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	IntegrationType	true	none	none
updated_at	string(date-time)	true	none	none

GetInviteResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "expires_at": {
      "format": "date-time",
      "type": "string"
    },
    "invite_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "responded_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "ACCEPTED",
        "EXPIRED",
        "PENDING",
        "REJECTED"
      ],
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "email",
    "expires_at",
    "invite_id",
    "organization_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	InviteStatus	true	none	none

GetKnowledgeBaseJobResponseContent

{
  "properties": {
    "bytes_ingested": {
      "type": "number"
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "errors": {
      "items": {
        "properties": {
          "message": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "message",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "knowledge_base_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "knowledge_base_job_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "status": {
      "enum": [
        "QUEUED",
        "RUNNING",
        "SUCCEEDED",
        "FAILED",
        "CANCELLED"
      ],
      "type": "string"
    },
    "status_detail": {}
  },
  "required": [
    "created_at",
    "created_by",
    "knowledge_base_id",
    "knowledge_base_job_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	none
knowledge_base_id	string	true	none	none
knowledge_base_job_id	string	true	none	none
status	KnowledgeBaseJobStatus	true	none	none
status_detail	any	false	none	none

GetKnowledgeBaseQueryResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "entries": {
      "items": {
        "properties": {
          "id": {
            "type": "string"
          },
          "meta": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "namespace": {
            "type": "string"
          },
          "score": {
            "format": "float",
            "type": "number"
          },
          "vector": {
            "items": {
              "format": "float",
              "type": "number"
            },
            "type": "array"
          }
        },
        "required": [
          "id",
          "score"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "knowledge_base_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "knowledge_base_query_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "query": {
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "entries",
    "knowledge_base_id",
    "knowledge_base_query_id",
    "query"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
entries	[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

{
  "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

Name	Type	Required	Restrictions	Description
asset_paths	[string]	true	none	none
config	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	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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	Metadata	true	none	none
output	string	true	none	none
thread_id	string	true	none	none
updated_at	string(date-time)	true	none	none

GetOrganizationResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "default_bucket_id": {
      "type": "string"
    },
    "description": {
      "maxLength": 2000,
      "type": "string"
    },
    "entitlement": {
      "allOf": [
        {
          "enum": [
            "FREE",
            "PAID",
            "PARTNER",
            "UNPAID",
            "EXPIRED"
          ],
          "type": "string"
        },
        {
          "default": "FREE"
        }
      ]
    },
    "model_config": {
      "properties": {
        "default_chat_model": {
          "type": "string"
        },
        "default_embedding_model": {
          "type": "string"
        },
        "default_image_generation_model": {
          "type": "string"
        },
        "default_rerank_model": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "default_bucket_id",
    "description",
    "entitlement",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

Name	Type	Required	Restrictions	Description
» anonymous	Entitlement	false	none	none

and

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

continued

Name	Type	Required	Restrictions	Description
model_config	OrganizationModelConfig	false	none	none
name	string	true	none	none
organization_id	string	true	none	none
updated_at	string(date-time)	true	none	none

GetRetrieverComponentResponseContent

{
  "properties": {
    "config": {},
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "retriever_component_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "config",
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "retriever_component_id",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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	[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

{
  "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

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
metadata	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

{
  "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

Name	Type	Required	Restrictions	Description
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	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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "format": "byte",
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string(byte)	false	none	none

GetStructureRunResponseContent

{
  "properties": {
    "args": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "output": {},
    "output_timestamp": {
      "format": "double",
      "type": "number"
    },
    "started_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "status": {
      "enum": [
        "QUEUED",
        "STARTING",
        "RUNNING",
        "SUCCEEDED",
        "FAILED",
        "ERROR",
        "CANCELLED"
      ],
      "type": "string"
    },
    "status_detail": {},
    "structure_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_run_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "args",
    "completed_at",
    "created_at",
    "created_by",
    "started_at",
    "status",
    "structure_id",
    "structure_run_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[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	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

{
  "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

Name	Type	Required	Restrictions	Description
deployment_count_gauge	DeploymentCountGauge	false	none	none
deployment_duration_gauge	DeploymentDurationGauge	false	none	none
deployment_error_rate_gauge	DeploymentErrorRateGauge	false	none	none
duration_plot	DurationPlot	false	none	none
error_rate_gauge	DeploymentErrorRateGauge	false	none	none
run_count_gauge	RunCountGauge	false	none	none
run_duration_gauge	RunDurationGauge	false	none	none
token_count_gauge	TokenCountGauge	false	none	none

GetThreadResponseContent

{
  "properties": {
    "alias": {
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "thread_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "alias",
    "created_at",
    "created_by",
    "metadata",
    "name",
    "organization_id",
    "thread_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
alias	string	true	none	none
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
metadata	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

{
  "properties": {
    "access_token": {
      "type": "string"
    }
  },
  "required": [
    "access_token"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
access_token	string	true	none	none

GetToolOpenApiRunOutputPayload

{}

Properties

• None*

GetToolResponseContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "latest_deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "tool_config_file": {
      "type": "string"
    },
    "tool_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "code",
    "created_at",
    "created_by",
    "description",
    "env_vars",
    "latest_deployment_id",
    "name",
    "organization_id",
    "tool_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
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	[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	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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
app_id	string	false	none	none
private_key_secret_ref	string	false	none	none
webhook_secret_ref	string	false	none	none

GitHubCredentialsInput

{
  "properties": {
    "auth_code": {
      "type": "string"
    }
  },
  "required": [
    "auth_code"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
auth_code	string	true	none	none

GithubCodeSource

{
  "properties": {
    "commit_sha": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
commit_sha	string	false	none	none

GithubCodeSourceInput

{
  "properties": {
    "access_token": {
      "maxLength": 1000,
      "minLength": 1,
      "type": "string"
    },
    "commit_sha": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
access_token	string	false	none	none
commit_sha	string	false	none	none

GithubFunctionCode

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "owner": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "push": {
      "properties": {
        "branch": {
          "maxLength": 200,
          "minLength": 1,
          "type": "string"
        },
        "tag": {
          "maxLength": 200,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "branch"
      ],
      "type": "object"
    }
  },
  "required": [
    "name",
    "owner",
    "push"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
owner	string	true	none	none
push	GithubFunctionCodePushConfig	true	none	none

GithubFunctionCodePushConfig

{
  "properties": {
    "branch": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "tag": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "branch"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
branch	string	true	none	none
tag	string	false	none	none

GithubStructureCode

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "owner": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "push": {
      "properties": {
        "branch": {
          "maxLength": 200,
          "minLength": 1,
          "type": "string"
        },
        "tag": {
          "maxLength": 200,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "branch"
      ],
      "type": "object"
    }
  },
  "required": [
    "name",
    "owner",
    "push"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
owner	string	true	none	none
push	GithubStructureCodePushConfig	true	none	none

GithubStructureCodePushConfig

{
  "properties": {
    "branch": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "tag": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "branch"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
branch	string	true	none	none
tag	string	false	none	none

GithubToolCode

{
  "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

Name	Type	Required	Restrictions	Description
name	string	true	none	none
owner	string	true	none	none
push	GithubToolCodePushConfig	true	none	none

GithubToolCodePushConfig

{
  "properties": {
    "branch": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "tag": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "branch"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
branch	string	true	none	none
tag	string	false	none	none

GoogleDriveDetail

{
  "properties": {
    "access_token": {
      "type": "string"
    },
    "file_ids": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "access_token",
    "file_ids"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
access_token	string	true	none	none
file_ids	[string]	true	none	none

GoogleDriveInput

{
  "properties": {
    "auth_code": {
      "type": "string"
    },
    "file_ids": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "auth_code",
    "file_ids"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
auth_code	string	true	none	none
file_ids	[string]	true	none	none

IntegrationConfigInputUnion

{
  "oneOf": [
    {
      "properties": {
        "slack": {
          "properties": {
            "app_description": {
              "type": "string"
            },
            "app_display_name": {
              "type": "string"
            },
            "app_name": {
              "type": "string"
            },
            "bot_token_secret_ref": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "signing_secret_secret_ref": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            }
          },
          "required": [
            "app_description",
            "app_display_name",
            "app_name"
          ],
          "type": "object"
        }
      },
      "required": [
        "slack"
      ],
      "title": "slack",
      "type": "object"
    },
    {
      "properties": {
        "github_app": {
          "properties": {
            "app_id": {
              "type": "string"
            },
            "private_key_secret_ref": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "webhook_secret_ref": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            }
          },
          "type": "object"
        }
      },
      "required": [
        "github_app"
      ],
      "title": "github_app",
      "type": "object"
    },
    {
      "properties": {
        "webhook": {
          "properties": {
            "disable_api_key_param": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "required": [
        "webhook"
      ],
      "title": "webhook",
      "type": "object"
    }
  ]
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» slack	SlackInput	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» github_app	GitHubAppInput	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» webhook	WebhookInput	true	none	none

IntegrationConfigUnion

{
  "oneOf": [
    {
      "properties": {
        "slack": {
          "properties": {
            "app_description": {
              "type": "string"
            },
            "app_display_name": {
              "type": "string"
            },
            "app_manifest": {},
            "app_name": {
              "type": "string"
            },
            "bot_token_secret_ref": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "signing_secret_secret_ref": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            }
          },
          "required": [
            "app_description",
            "app_display_name",
            "app_manifest",
            "app_name",
            "bot_token_secret_ref",
            "signing_secret_secret_ref"
          ],
          "type": "object"
        }
      },
      "required": [
        "slack"
      ],
      "title": "slack",
      "type": "object"
    },
    {
      "properties": {
        "github_app": {
          "properties": {
            "app_id": {
              "type": "string"
            },
            "integration_endpoint": {
              "type": "string"
            },
            "private_key_secret_ref": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "webhook_secret_ref": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            }
          },
          "required": [
            "app_id",
            "integration_endpoint",
            "private_key_secret_ref",
            "webhook_secret_ref"
          ],
          "type": "object"
        }
      },
      "required": [
        "github_app"
      ],
      "title": "github_app",
      "type": "object"
    },
    {
      "properties": {
        "webhook": {
          "properties": {
            "disable_api_key_param": {
              "type": "boolean"
            },
            "integration_endpoint": {
              "type": "string"
            }
          },
          "required": [
            "disable_api_key_param",
            "integration_endpoint"
          ],
          "type": "object"
        }
      },
      "required": [
        "webhook"
      ],
      "title": "webhook",
      "type": "object"
    }
  ]
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» slack	SlackDetail	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» github_app	GitHubAppDetail	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» webhook	WebhookDetail	true	none	none

IntegrationDetail

{
  "properties": {
    "assistant_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "config": {
      "oneOf": [
        {
          "properties": {
            "slack": {
              "properties": {
                "app_description": {
                  "type": "string"
                },
                "app_display_name": {
                  "type": "string"
                },
                "app_manifest": {},
                "app_name": {
                  "type": "string"
                },
                "bot_token_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                },
                "signing_secret_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "app_description",
                "app_display_name",
                "app_manifest",
                "app_name",
                "bot_token_secret_ref",
                "signing_secret_secret_ref"
              ],
              "type": "object"
            }
          },
          "required": [
            "slack"
          ],
          "title": "slack",
          "type": "object"
        },
        {
          "properties": {
            "github_app": {
              "properties": {
                "app_id": {
                  "type": "string"
                },
                "integration_endpoint": {
                  "type": "string"
                },
                "private_key_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                },
                "webhook_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "app_id",
                "integration_endpoint",
                "private_key_secret_ref",
                "webhook_secret_ref"
              ],
              "type": "object"
            }
          },
          "required": [
            "github_app"
          ],
          "title": "github_app",
          "type": "object"
        },
        {
          "properties": {
            "webhook": {
              "properties": {
                "disable_api_key_param": {
                  "type": "boolean"
                },
                "integration_endpoint": {
                  "type": "string"
                }
              },
              "required": [
                "disable_api_key_param",
                "integration_endpoint"
              ],
              "type": "object"
            }
          },
          "required": [
            "webhook"
          ],
          "title": "webhook",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "integration_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "enum": [
        "slack",
        "github_app",
        "webhook"
      ],
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "assistant_ids",
    "config",
    "created_at",
    "created_by",
    "description",
    "integration_id",
    "name",
    "organization_id",
    "structure_ids",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	true	none	none
config	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	IntegrationType	true	none	none
updated_at	string(date-time)	true	none	none

IntegrationType

{
  "enum": [
    "slack",
    "github_app",
    "webhook"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	slack
anonymous	github_app
anonymous	webhook

InviteDetail

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "expires_at": {
      "format": "date-time",
      "type": "string"
    },
    "invite_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "responded_at": {
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "enum": [
        "ACCEPTED",
        "EXPIRED",
        "PENDING",
        "REJECTED"
      ],
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "email",
    "expires_at",
    "invite_id",
    "organization_id",
    "status"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	InviteStatus	true	none	none

InviteResponseStatus

{
  "enum": [
    "ACCEPTED",
    "REJECTED"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	ACCEPTED
anonymous	REJECTED

InviteStatus

{
  "enum": [
    "ACCEPTED",
    "EXPIRED",
    "PENDING",
    "REJECTED"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	ACCEPTED
anonymous	EXPIRED
anonymous	PENDING
anonymous	REJECTED

InvokeStructureWebhookGetResponseContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "latest_deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_config_file": {
      "type": "string"
    },
    "structure_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "webhook_enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "code",
    "created_at",
    "created_by",
    "description",
    "env_vars",
    "latest_deployment_id",
    "name",
    "organization_id",
    "structure_id",
    "updated_at",
    "webhook_enabled"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
additionalProperties	boolean	true	none	none
description	string	true	none	none
id	string	true	none	none
properties	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

{
  "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

Name	Type	Required	Restrictions	Description
member	JsonSchemaProperty	false	none	none

JsonSchemaProperty

{
  "properties": {
    "additionalProperties": {
      "type": "boolean"
    },
    "description": {
      "type": "string"
    },
    "properties": {
      "properties": {
        "member": "[Circular]"
      },
      "type": "object"
    },
    "required": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "additionalProperties",
    "description",
    "properties",
    "required",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	boolean	true	none	none
description	string	true	none	none
properties	JsonSchemaProperties	true	none	none
required	[string]	true	none	none
type	string	true	none	none

KnowledgeBaseConfigInputUnion

{
  "oneOf": [
    {
      "properties": {
        "pg_vector": {
          "properties": {
            "connection_string": {
              "type": "string"
            },
            "embedding_model": {
              "type": "string"
            },
            "password": {
              "type": "string"
            },
            "use_default_embedding_model": {
              "type": "boolean"
            }
          },
          "required": [
            "connection_string",
            "password"
          ],
          "type": "object"
        }
      },
      "required": [
        "pg_vector"
      ],
      "title": "pg_vector",
      "type": "object"
    },
    {
      "properties": {
        "gtc_pg_vector": {
          "properties": {
            "embedding_model": {
              "type": "string"
            },
            "use_default_embedding_model": {
              "type": "boolean"
            }
          },
          "type": "object"
        }
      },
      "required": [
        "gtc_pg_vector"
      ],
      "title": "gtc_pg_vector",
      "type": "object"
    },
    {
      "properties": {
        "gtc_hybrid_sql_pg_vector": {
          "properties": {
            "embedding_model": {
              "type": "string"
            },
            "structured_columns": {
              "items": {
                "properties": {
                  "column_name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  },
                  "sql_type": {
                    "type": "string"
                  }
                },
                "required": [
                  "column_name",
                  "description",
                  "sql_type"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "unstructured_columns": {
              "items": {
                "properties": {
                  "column_name": {
                    "type": "string"
                  },
                  "description": {
                    "type": "string"
                  }
                },
                "required": [
                  "column_name",
                  "description"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "use_default_embedding_model": {
              "type": "boolean"
            }
          },
          "required": [
            "structured_columns",
            "unstructured_columns"
          ],
          "type": "object"
        }
      },
      "required": [
        "gtc_hybrid_sql_pg_vector"
      ],
      "title": "gtc_hybrid_sql_pg_vector",
      "type": "object"
    },
    {
      "properties": {
        "pgai_knowledge_base": {
          "type": "object"
        }
      },
      "required": [
        "pgai_knowledge_base"
      ],
      "title": "pgai_knowledge_base",
      "type": "object"
    }
  ]
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» pg_vector	GTCHybidSQLPGVectorKnowledgeBaseInput	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» gtc_pg_vector	GTCPGVectorKnowledgeBaseInput	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» gtc_hybrid_sql_pg_vector	GTCHybidSQLPGVectorKnowledgeBaseInput	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» pgai_knowledge_base	PGAIKnowledgeBaseKnowledgeBaseInput	true	none	none

KnowledgeBaseConfigUnion

{
  "oneOf": [
    {
      "properties": {
        "pg_vector": {
          "properties": {
            "connection_string": {
              "type": "string"
            },
            "embedding_model": {
              "type": "string"
            },
            "query_schema": {},
            "use_default_embedding_model": {
              "type": "boolean"
            }
          },
          "required": [
            "connection_string",
            "embedding_model",
            "query_schema",
            "use_default_embedding_model"
          ],
          "type": "object"
        }
      },
      "required": [
        "pg_vector"
      ],
      "title": "pg_vector",
      "type": "object"
    },
    {
      "properties": {
        "gtc_pg_vector": {
          "properties": {
            "embedding_model": {
              "type": "string"
            },
            "query_schema": {},
            "use_default_embedding_model": {
              "type": "boolean"
            }
          },
          "required": [
            "embedding_model",
            "query_schema",
            "use_default_embedding_model"
          ],
          "type": "object"
        }
      },
      "required": [
        "gtc_pg_vector"
      ],
      "title": "gtc_pg_vector",
      "type": "object"
    },
    {
      "properties": {
        "gtc_hybrid_sql_pg_vector": {
          "properties": {
            "embedding_model": {
              "type": "string"
            },
            "query_schema": {},
            "structured_columns": {
              "items": {
                "properties": {
                  "column_name": {
                    "type": "string"
                  },
                  "sql_type": {
                    "type": "string"
                  }
                },
                "required": [
                  "column_name",
                  "sql_type"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "unstructured_columns": {
              "items": {
                "properties": {
                  "column_name": {
                    "type": "string"
                  }
                },
                "required": [
                  "column_name"
                ],
                "type": "object"
              },
              "type": "array"
            },
            "use_default_embedding_model": {
              "type": "boolean"
            }
          },
          "required": [
            "embedding_model",
            "query_schema",
            "structured_columns",
            "unstructured_columns",
            "use_default_embedding_model"
          ],
          "type": "object"
        }
      },
      "required": [
        "gtc_hybrid_sql_pg_vector"
      ],
      "title": "gtc_hybrid_sql_pg_vector",
      "type": "object"
    },
    {
      "properties": {
        "pgai_knowledge_base": {
          "properties": {
            "knowledge_base_name": {
              "type": "string"
            },
            "query_schema": {}
          },
          "required": [
            "knowledge_base_name",
            "query_schema"
          ],
          "type": "object"
        }
      },
      "required": [
        "pgai_knowledge_base"
      ],
      "title": "pgai_knowledge_base",
      "type": "object"
    }
  ]
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» pg_vector	GTCHybidSQLPGVectorKnowledgeBaseDetail	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» gtc_pg_vector	GTCPGVectorKnowledgeBaseDetail	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» gtc_hybrid_sql_pg_vector	GTCHybidSQLPGVectorKnowledgeBaseDetail	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» pgai_knowledge_base	PGAIKnowledgeBaseKnowledgeBaseDetail	true	none	none

KnowledgeBaseDetail

{
  "properties": {
    "asset_paths": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "config": {
      "oneOf": [
        {
          "properties": {
            "pg_vector": {
              "properties": {
                "connection_string": {
                  "type": "string"
                },
                "embedding_model": {
                  "type": "string"
                },
                "query_schema": {},
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "connection_string",
                "embedding_model",
                "query_schema",
                "use_default_embedding_model"
              ],
              "type": "object"
            }
          },
          "required": [
            "pg_vector"
          ],
          "title": "pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "gtc_pg_vector": {
              "properties": {
                "embedding_model": {
                  "type": "string"
                },
                "query_schema": {},
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "embedding_model",
                "query_schema",
                "use_default_embedding_model"
              ],
              "type": "object"
            }
          },
          "required": [
            "gtc_pg_vector"
          ],
          "title": "gtc_pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "gtc_hybrid_sql_pg_vector": {
              "properties": {
                "embedding_model": {
                  "type": "string"
                },
                "query_schema": {},
                "structured_columns": {
                  "items": {
                    "properties": {
                      "column_name": {
                        "type": "string"
                      },
                      "sql_type": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "column_name",
                      "sql_type"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "unstructured_columns": {
                  "items": {
                    "properties": {
                      "column_name": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "column_name"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "embedding_model",
                "query_schema",
                "structured_columns",
                "unstructured_columns",
                "use_default_embedding_model"
              ],
              "type": "object"
            }
          },
          "required": [
            "gtc_hybrid_sql_pg_vector"
          ],
          "title": "gtc_hybrid_sql_pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "pgai_knowledge_base": {
              "properties": {
                "knowledge_base_name": {
                  "type": "string"
                },
                "query_schema": {}
              },
              "required": [
                "knowledge_base_name",
                "query_schema"
              ],
              "type": "object"
            }
          },
          "required": [
            "pgai_knowledge_base"
          ],
          "title": "pgai_knowledge_base",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "embedding_model": {
      "enum": [
        "text-embedding-ada-002",
        "text-embedding-3-small"
      ],
      "type": "string"
    },
    "knowledge_base_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "schedule_expression": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "transforms": {
      "items": {
        "properties": {
          "structure": {
            "properties": {
              "args": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "structure_id": {
                "type": "string"
              }
            },
            "required": [
              "structure_id"
            ],
            "type": "object"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "required": [
    "asset_paths",
    "config",
    "created_at",
    "created_by",
    "knowledge_base_id",
    "name",
    "organization_id",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
asset_paths	[string]	true	none	none
config	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	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	none
knowledge_base_id	string	true	none	none
knowledge_base_job_id	string	true	none	none
status	KnowledgeBaseJobStatus	true	none	none
status_detail	any	false	none	none

KnowledgeBaseJobStatus

{
  "enum": [
    "QUEUED",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "CANCELLED"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	QUEUED
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	CANCELLED

KnowledgeBaseQueryDetail

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "entries": {
      "items": {
        "properties": {
          "id": {
            "type": "string"
          },
          "meta": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "namespace": {
            "type": "string"
          },
          "score": {
            "format": "float",
            "type": "number"
          },
          "vector": {
            "items": {
              "format": "float",
              "type": "number"
            },
            "type": "array"
          }
        },
        "required": [
          "id",
          "score"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "knowledge_base_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "knowledge_base_query_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "query": {
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "entries",
    "knowledge_base_id",
    "knowledge_base_query_id",
    "query"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
entries	[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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
api_keys	tool_id ]	true	none	none
pagination	Pagination	true	none	none

ListAssetsResponseContent

{
  "properties": {
    "assets": {
      "items": {
        "properties": {
          "bucket_id": {
            "type": "string"
          },
          "contents": {},
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "size": {
            "type": "number"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "created_by",
          "name",
          "organization_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "postfix": {
      "type": "string"
    },
    "prefix": {
      "type": "string"
    }
  },
  "required": [
    "assets",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
assets	[AssetDetail ]	true	none	none
pagination	Pagination	true	none	none
postfix	string	false	none	none
prefix	string	false	none	none

ListAssistantEventsResponseContent

{
  "properties": {
    "count": {
      "type": "number"
    },
    "events": {
      "items": {
        "properties": {
          "assistant_run_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "event_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "origin": {
            "type": "string"
          },
          "payload": {},
          "timestamp": {
            "format": "double",
            "type": "number"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "assistant_run_id",
          "created_at",
          "event_id",
          "origin",
          "payload",
          "timestamp",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "limit": {
      "type": "number"
    },
    "next_offset": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "total_count": {
      "type": "number"
    }
  },
  "required": [
    "count",
    "events",
    "limit",
    "next_offset",
    "offset",
    "total_count"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
count	number	true	none	none
events	[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

{
  "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

Name	Type	Required	Restrictions	Description
assistant_runs	[AssistantRunDetail ]	true	none	none
pagination	Pagination	true	none	none

ListAssistantsResponseContent

{
  "properties": {
    "assistants": {
      "items": {
        "properties": {
          "assistant_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "input": {
            "type": "string"
          },
          "knowledge_base_ids": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "retriever_ids": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "ruleset_ids": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "structure_ids": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "tool_ids": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "assistant_id",
          "created_at",
          "created_by",
          "description",
          "knowledge_base_ids",
          "name",
          "organization_id",
          "retriever_ids",
          "ruleset_ids",
          "structure_ids",
          "tool_ids",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "assistants",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
assistants	[AssistantDetail ]	true	none	none
pagination	Pagination	true	none	none

ListBucketsResponseContent

{
  "properties": {
    "buckets": {
      "items": {
        "properties": {
          "bucket_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "bucket_id",
          "created_at",
          "created_by",
          "name",
          "organization_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "buckets",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
buckets	[BucketDetail ]	true	none	none
pagination	Pagination	true	none	none

ListConnectionsResponseContent

{
  "properties": {
    "connections": {
      "items": {
        "properties": {
          "connection_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "connection_id",
          "created_at",
          "created_by",
          "name",
          "type",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
connections	[ConnectionDetail ]	false	none	none

ListDataConnectorsResponseContent

{
  "properties": {
    "data_connectors": {
      "items": {
        "properties": {
          "bucket_id": {
            "type": "string"
          },
          "config": {
            "oneOf": [
              {
                "properties": {
                  "confluence": {
                    "properties": {
                      "atlassian_email": {
                        "type": "string"
                      },
                      "domain": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "atlassian_email",
                      "domain"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "confluence"
                ],
                "title": "confluence",
                "type": "object"
              },
              {
                "properties": {
                  "google_drive": {
                    "properties": {
                      "access_token": {
                        "type": "string"
                      },
                      "file_ids": {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "required": [
                      "access_token",
                      "file_ids"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "google_drive"
                ],
                "title": "google_drive",
                "type": "object"
              },
              {
                "properties": {
                  "webscraper": {
                    "properties": {
                      "urls": {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "required": [
                      "urls"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "webscraper"
                ],
                "title": "webscraper",
                "type": "object"
              },
              {
                "properties": {
                  "structure": {
                    "properties": {
                      "args": {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "structure_id": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "structure_id"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "structure"
                ],
                "title": "structure",
                "type": "object"
              },
              {
                "properties": {
                  "s3": {
                    "properties": {
                      "aws_access_key_id": {
                        "type": "string"
                      },
                      "uris": {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      }
                    },
                    "required": [
                      "aws_access_key_id",
                      "uris"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "s3"
                ],
                "title": "s3",
                "type": "object"
              },
              {
                "properties": {
                  "data_lake": {
                    "properties": {
                      "asset_paths": {
                        "items": {
                          "type": "string"
                        },
                        "type": "array"
                      },
                      "bucket_id": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "asset_paths",
                      "bucket_id"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data_lake"
                ],
                "title": "data_lake",
                "type": "object"
              }
            ]
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "data_connector_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "schedule_expression": {
            "type": "string"
          },
          "transforms": {
            "items": {
              "properties": {
                "structure": {
                  "properties": {
                    "args": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array"
                    },
                    "structure_id": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "structure_id"
                  ],
                  "type": "object"
                }
              },
              "type": "object"
            },
            "type": "array"
          },
          "type": {
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "config",
          "created_at",
          "created_by",
          "data_connector_id",
          "name",
          "organization_id",
          "type",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "data_connectors",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
data_connectors	[DataConnectorDetail ]	true	none	none
pagination	Pagination	true	none	none

ListDataJobsResponseContent

{
  "properties": {
    "data_jobs": {
      "items": {
        "properties": {
          "bytes_ingested": {
            "type": "number"
          },
          "completed_at": {
            "default": null,
            "format": "date-time",
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "data_connector_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "data_job_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "errors": {
            "items": {
              "properties": {
                "message": {
                  "type": "string"
                },
                "path": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "message",
                "type"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "status": {
            "enum": [
              "QUEUED",
              "RUNNING",
              "SUCCEEDED",
              "FAILED",
              "CANCELLED"
            ],
            "type": "string"
          },
          "status_detail": {}
        },
        "required": [
          "created_at",
          "created_by",
          "data_connector_id",
          "data_job_id",
          "status"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "data_jobs",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
data_jobs	[DataJobDetail ]	true	none	none
pagination	Pagination	true	none	none

ListEventsResponseContent

{
  "properties": {
    "count": {
      "type": "number"
    },
    "events": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "event_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "origin": {
            "type": "string"
          },
          "payload": {},
          "structure_run_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "timestamp": {
            "format": "double",
            "type": "number"
          },
          "type": {
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "event_id",
          "origin",
          "payload",
          "structure_run_id",
          "timestamp",
          "type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "limit": {
      "type": "number"
    },
    "next_offset": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "total_count": {
      "type": "number"
    }
  },
  "required": [
    "count",
    "events",
    "limit",
    "next_offset",
    "offset",
    "total_count"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
count	number	true	none	none
events	[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

{
  "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

Name	Type	Required	Restrictions	Description
deployments	[FunctionDeploymentDetail ]	true	none	none
pagination	Pagination	true	none	none

ListFunctionRunLogsResponseContent

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
logs	[string]	true	none	none

ListFunctionRunsResponseContent

{
  "properties": {
    "function_runs": {
      "items": {
        "properties": {
          "completed_at": {
            "default": null,
            "format": "date-time",
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "deployment_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "env_vars": {
            "items": {
              "properties": {
                "name": {
                  "type": "string"
                },
                "source": {
                  "enum": [
                    "secret_ref",
                    "manual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "function_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "function_run_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "input": {},
          "output": {},
          "output_timestamp": {
            "format": "double",
            "type": "number"
          },
          "runtime_path": {
            "type": "string"
          },
          "started_at": {
            "default": null,
            "format": "date-time",
            "type": "string",
            "nullable": true
          },
          "status": {
            "enum": [
              "QUEUED",
              "STARTING",
              "RUNNING",
              "SUCCEEDED",
              "FAILED",
              "ERROR",
              "CANCELLED"
            ],
            "type": "string"
          },
          "status_detail": {},
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "completed_at",
          "created_at",
          "created_by",
          "function_id",
          "function_run_id",
          "input",
          "runtime_path",
          "started_at",
          "status",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "function_runs",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
function_runs	[FunctionRunDetail ]	true	none	none
pagination	Pagination	true	none	none

ListFunctionsResponseContent

{
  "properties": {
    "functions": {
      "items": {
        "properties": {
          "code": {
            "oneOf": [
              {
                "properties": {
                  "github": {
                    "properties": {
                      "name": {
                        "maxLength": 200,
                        "minLength": 1,
                        "type": "string"
                      },
                      "owner": {
                        "maxLength": 200,
                        "minLength": 1,
                        "type": "string"
                      },
                      "push": {
                        "properties": {
                          "branch": {
                            "maxLength": 200,
                            "minLength": 1,
                            "type": "string"
                          },
                          "tag": {
                            "maxLength": 200,
                            "minLength": 1,
                            "type": "string"
                          }
                        },
                        "required": [
                          "branch"
                        ],
                        "type": "object"
                      }
                    },
                    "required": [
                      "name",
                      "owner",
                      "push"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "github"
                ],
                "title": "github",
                "type": "object"
              },
              {
                "properties": {
                  "data_lake": {
                    "properties": {
                      "asset_path": {
                        "type": "string"
                      },
                      "bucket_id": {
                        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "asset_path",
                      "bucket_id"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data_lake"
                ],
                "title": "data_lake",
                "type": "object"
              },
              {
                "properties": {
                  "default": {
                    "type": "object"
                  }
                },
                "required": [
                  "default"
                ],
                "title": "default",
                "type": "object"
              }
            ]
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "env_vars": {
            "items": {
              "properties": {
                "name": {
                  "type": "string"
                },
                "source": {
                  "enum": [
                    "secret_ref",
                    "manual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "function_config_file": {
            "type": "string"
          },
          "function_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "latest_deployment_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "code",
          "created_at",
          "created_by",
          "description",
          "env_vars",
          "function_id",
          "latest_deployment_id",
          "name",
          "organization_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "functions",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
functions	[FunctionDetail ]	true	none	none
pagination	Pagination	true	none	none

ListIntegrationsResponseContent

{
  "properties": {
    "integrations": {
      "items": {
        "properties": {
          "assistant_ids": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "config": {
            "oneOf": [
              {
                "properties": {
                  "slack": {
                    "properties": {
                      "app_description": {
                        "type": "string"
                      },
                      "app_display_name": {
                        "type": "string"
                      },
                      "app_manifest": {},
                      "app_name": {
                        "type": "string"
                      },
                      "bot_token_secret_ref": {
                        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                        "type": "string"
                      },
                      "signing_secret_secret_ref": {
                        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "app_description",
                      "app_display_name",
                      "app_manifest",
                      "app_name",
                      "bot_token_secret_ref",
                      "signing_secret_secret_ref"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "slack"
                ],
                "title": "slack",
                "type": "object"
              },
              {
                "properties": {
                  "github_app": {
                    "properties": {
                      "app_id": {
                        "type": "string"
                      },
                      "integration_endpoint": {
                        "type": "string"
                      },
                      "private_key_secret_ref": {
                        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                        "type": "string"
                      },
                      "webhook_secret_ref": {
                        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "app_id",
                      "integration_endpoint",
                      "private_key_secret_ref",
                      "webhook_secret_ref"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "github_app"
                ],
                "title": "github_app",
                "type": "object"
              },
              {
                "properties": {
                  "webhook": {
                    "properties": {
                      "disable_api_key_param": {
                        "type": "boolean"
                      },
                      "integration_endpoint": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "disable_api_key_param",
                      "integration_endpoint"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "webhook"
                ],
                "title": "webhook",
                "type": "object"
              }
            ]
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "integration_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "structure_ids": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "type": {
            "enum": [
              "slack",
              "github_app",
              "webhook"
            ],
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "assistant_ids",
          "config",
          "created_at",
          "created_by",
          "description",
          "integration_id",
          "name",
          "organization_id",
          "structure_ids",
          "type",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "integrations",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
integrations	[IntegrationDetail ]	true	none	none
pagination	Pagination	true	none	none

ListInvitesResponseContent

{
  "properties": {
    "invites": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "expires_at": {
            "format": "date-time",
            "type": "string"
          },
          "invite_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "responded_at": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "enum": [
              "ACCEPTED",
              "EXPIRED",
              "PENDING",
              "REJECTED"
            ],
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "created_by",
          "email",
          "expires_at",
          "invite_id",
          "organization_id",
          "status"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "invites",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
invites	[InviteDetail ]	true	none	none
pagination	Pagination	true	none	none

ListKnowledgeBaseJobsResponseContent

{
  "properties": {
    "knowledge_base_jobs": {
      "items": {
        "properties": {
          "bytes_ingested": {
            "type": "number"
          },
          "completed_at": {
            "default": null,
            "format": "date-time",
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "errors": {
            "items": {
              "properties": {
                "message": {
                  "type": "string"
                },
                "path": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                }
              },
              "required": [
                "message",
                "type"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "knowledge_base_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "knowledge_base_job_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "status": {
            "enum": [
              "QUEUED",
              "RUNNING",
              "SUCCEEDED",
              "FAILED",
              "CANCELLED"
            ],
            "type": "string"
          },
          "status_detail": {}
        },
        "required": [
          "created_at",
          "created_by",
          "knowledge_base_id",
          "knowledge_base_job_id",
          "status"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "knowledge_base_jobs",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
knowledge_base_jobs	[KnowledgeBaseJobDetail ]	true	none	none
pagination	Pagination	true	none	none

ListKnowledgeBaseQueriesResponseContent

{
  "properties": {
    "knowledge_base_queries": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "entries": {
            "items": {
              "properties": {
                "id": {
                  "type": "string"
                },
                "meta": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object"
                },
                "namespace": {
                  "type": "string"
                },
                "score": {
                  "format": "float",
                  "type": "number"
                },
                "vector": {
                  "items": {
                    "format": "float",
                    "type": "number"
                  },
                  "type": "array"
                }
              },
              "required": [
                "id",
                "score"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "knowledge_base_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "knowledge_base_query_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "query": {
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "created_by",
          "entries",
          "knowledge_base_id",
          "knowledge_base_query_id",
          "query"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
knowledge_base_queries	[KnowledgeBaseQueryDetail ]	false	none	none

ListKnowledgeBaseSearchesResponseContent

{
  "properties": {
    "knowledge_base_searches": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "knowledge_base_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "knowledge_base_search_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "query": {
            "type": "string"
          },
          "result": {
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "created_by",
          "knowledge_base_id",
          "knowledge_base_search_id",
          "query",
          "result"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
knowledge_base_searches	[KnowledgeBaseSearchDetail ]	false	none	none

ListKnowledgeBasesResponseContent

{
  "properties": {
    "knowledge_bases": {
      "items": {
        "properties": {
          "asset_paths": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "config": {
            "oneOf": [
              {
                "properties": {
                  "pg_vector": {
                    "properties": {
                      "connection_string": {
                        "type": "string"
                      },
                      "embedding_model": {
                        "type": "string"
                      },
                      "query_schema": {},
                      "use_default_embedding_model": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "connection_string",
                      "embedding_model",
                      "query_schema",
                      "use_default_embedding_model"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "pg_vector"
                ],
                "title": "pg_vector",
                "type": "object"
              },
              {
                "properties": {
                  "gtc_pg_vector": {
                    "properties": {
                      "embedding_model": {
                        "type": "string"
                      },
                      "query_schema": {},
                      "use_default_embedding_model": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "embedding_model",
                      "query_schema",
                      "use_default_embedding_model"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "gtc_pg_vector"
                ],
                "title": "gtc_pg_vector",
                "type": "object"
              },
              {
                "properties": {
                  "gtc_hybrid_sql_pg_vector": {
                    "properties": {
                      "embedding_model": {
                        "type": "string"
                      },
                      "query_schema": {},
                      "structured_columns": {
                        "items": {
                          "properties": {
                            "column_name": {
                              "type": "string"
                            },
                            "sql_type": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "column_name",
                            "sql_type"
                          ],
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "unstructured_columns": {
                        "items": {
                          "properties": {
                            "column_name": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "column_name"
                          ],
                          "type": "object"
                        },
                        "type": "array"
                      },
                      "use_default_embedding_model": {
                        "type": "boolean"
                      }
                    },
                    "required": [
                      "embedding_model",
                      "query_schema",
                      "structured_columns",
                      "unstructured_columns",
                      "use_default_embedding_model"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "gtc_hybrid_sql_pg_vector"
                ],
                "title": "gtc_hybrid_sql_pg_vector",
                "type": "object"
              },
              {
                "properties": {
                  "pgai_knowledge_base": {
                    "properties": {
                      "knowledge_base_name": {
                        "type": "string"
                      },
                      "query_schema": {}
                    },
                    "required": [
                      "knowledge_base_name",
                      "query_schema"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "pgai_knowledge_base"
                ],
                "title": "pgai_knowledge_base",
                "type": "object"
              }
            ]
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "embedding_model": {
            "enum": [
              "text-embedding-ada-002",
              "text-embedding-3-small"
            ],
            "type": "string"
          },
          "knowledge_base_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "schedule_expression": {
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "transforms": {
            "items": {
              "properties": {
                "structure": {
                  "properties": {
                    "args": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array"
                    },
                    "structure_id": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "structure_id"
                  ],
                  "type": "object"
                }
              },
              "type": "object"
            },
            "type": "array"
          },
          "type": {
            "maxLength": 200,
            "minLength": 1,
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "use_default_embedding_model": {
            "type": "boolean"
          }
        },
        "required": [
          "asset_paths",
          "config",
          "created_at",
          "created_by",
          "knowledge_base_id",
          "name",
          "organization_id",
          "type",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "knowledge_bases",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
knowledge_bases	[KnowledgeBaseDetail ]	true	none	none
pagination	Pagination	true	none	none

ListLibrariesResponseContent

{
  "properties": {
    "libraries": {
      "items": {
        "properties": {
          "assistant_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "data_connector_ids": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "description": {
            "type": "string"
          },
          "knowledge_base_ids": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "library_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "retriever_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "assistant_id",
          "created_at",
          "created_by",
          "data_connector_ids",
          "knowledge_base_ids",
          "library_id",
          "name",
          "organization_id",
          "retriever_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "libraries",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
libraries	[LibraryDetail ]	true	none	none
pagination	Pagination	true	none	none

ListMessagesResponseContent

{
  "properties": {
    "messages": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "index": {
            "type": "number"
          },
          "input": {
            "type": "string"
          },
          "message_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {},
            "type": "object"
          },
          "output": {
            "type": "string"
          },
          "thread_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "created_by",
          "index",
          "input",
          "message_id",
          "metadata",
          "output",
          "thread_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "messages",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
messages	[MessageDetail ]	true	none	none
pagination	Pagination	true	none	none

ListModelsResponseContent

{
  "properties": {
    "models": {
      "items": {
        "properties": {
          "default": {
            "type": "boolean"
          },
          "description": {
            "type": "string"
          },
          "model_name": {
            "type": "string"
          },
          "model_type": {
            "enum": [
              "chat",
              "embedding",
              "rerank",
              "image_generation",
              "unknown"
            ],
            "type": "string"
          }
        },
        "required": [
          "default",
          "model_name",
          "model_type"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "models",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
models	[ModelDetail ]	true	none	none
pagination	Pagination	true	none	none

ListOrganizationApiKeysResponseContent

{
  "properties": {
    "api_keys": {
      "items": {
        "properties": {
          "active": {
            "type": "boolean"
          },
          "api_key_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "last_used": {
            "format": "date-time",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "active",
          "api_key_id",
          "created_at",
          "created_by",
          "last_used",
          "name",
          "organization_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "api_keys",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
api_keys	tool_id ]	true	none	none
pagination	Pagination	true	none	none

ListOrganizationUsersResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "users": {
      "items": {
        "properties": {
          "email": {
            "type": "string"
          },
          "user_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          }
        },
        "required": [
          "email",
          "user_id"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "users"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
users	[OrganizationUserDetail ]	true	none	none

ListOrganizationsResponseContent

{
  "properties": {
    "organizations": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "default_bucket_id": {
            "type": "string"
          },
          "description": {
            "maxLength": 2000,
            "type": "string"
          },
          "entitlement": {
            "allOf": [
              {
                "enum": [
                  "FREE",
                  "PAID",
                  "PARTNER",
                  "UNPAID",
                  "EXPIRED"
                ],
                "type": "string"
              },
              {
                "default": "FREE"
              }
            ]
          },
          "model_config": {
            "properties": {
              "default_chat_model": {
                "type": "string"
              },
              "default_embedding_model": {
                "type": "string"
              },
              "default_image_generation_model": {
                "type": "string"
              },
              "default_rerank_model": {
                "type": "string"
              }
            },
            "type": "object"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "created_by",
          "default_bucket_id",
          "description",
          "entitlement",
          "name",
          "organization_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
organizations	[OrganizationDetail ]	false	none	none

ListRetrieverComponentsResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "retriever_components": {
      "items": {
        "properties": {
          "config": {},
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "retriever_component_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "config",
          "created_at",
          "created_by",
          "name",
          "organization_id",
          "retriever_component_id",
          "type",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "retriever_components"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
retriever_components	[RetrieverComponentDetail ]	true	none	none

ListRetrieversResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "retrievers": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "retriever_components": {
            "items": {
              "properties": {
                "config": {},
                "created_at": {
                  "format": "date-time",
                  "type": "string"
                },
                "created_by": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "organization_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                },
                "retriever_component_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "updated_at": {
                  "format": "date-time",
                  "type": "string"
                }
              },
              "required": [
                "config",
                "created_at",
                "created_by",
                "name",
                "organization_id",
                "retriever_component_id",
                "type",
                "updated_at"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "retriever_components_schema": {},
          "retriever_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "created_by",
          "name",
          "organization_id",
          "retriever_components",
          "retriever_components_schema",
          "retriever_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "retrievers"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
retrievers	[RetrieverDetail ]	true	none	none

ListRulesResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "rules": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {},
            "type": "object"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "rule": {
            "type": "string"
          },
          "rule_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "created_by",
          "metadata",
          "name",
          "organization_id",
          "rule",
          "rule_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "rules"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
rules	[RuleDetail ]	true	none	none

ListRulesetsResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "rulesets": {
      "items": {
        "properties": {
          "alias": {
            "type": "string"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {},
            "type": "object"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "rule_ids": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "ruleset_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "alias",
          "created_at",
          "created_by",
          "description",
          "metadata",
          "name",
          "organization_id",
          "rule_ids",
          "ruleset_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "rulesets"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
rulesets	tool_id ]	true	none	none

ListSecretsResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "secrets": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "last_used": {
            "format": "date-time",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "secret_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "last_used",
          "name",
          "organization_id",
          "secret_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "secrets"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
secrets	[SecretDetail ]	true	none	none

ListSpansResponseContent

{
  "properties": {
    "page": {
      "type": "number"
    },
    "spans": {
      "items": {
        "properties": {
          "attributes": {},
          "end_time": {
            "format": "date-time",
            "type": "string"
          },
          "events": {
            "properties": {
              "attributes": {},
              "name": {
                "type": "string"
              },
              "timestamp": {
                "format": "date-time",
                "type": "string"
              }
            },
            "required": [
              "attributes",
              "name",
              "timestamp"
            ],
            "type": "object"
          },
          "name": {
            "type": "string"
          },
          "parent_id": {
            "type": "string"
          },
          "span_id": {
            "type": "string"
          },
          "start_time": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "enum": [
              "UNSET",
              "OK",
              "ERROR"
            ],
            "type": "string"
          },
          "trace_id": {
            "type": "string"
          }
        },
        "required": [
          "attributes",
          "end_time",
          "events",
          "name",
          "span_id",
          "start_time",
          "status",
          "trace_id"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "spans"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
page	number	false	none	none
spans	[SpanDetail ]	true	none	none

ListStructureDeploymentsResponseContent

{
  "properties": {
    "deployments": {
      "items": {
        "properties": {
          "code_source": {
            "oneOf": [
              {
                "properties": {
                  "github": {
                    "properties": {
                      "commit_sha": {
                        "maxLength": 200,
                        "minLength": 1,
                        "type": "string"
                      }
                    },
                    "type": "object"
                  }
                },
                "required": [
                  "github"
                ],
                "title": "github",
                "type": "object"
              },
              {
                "properties": {
                  "data_lake": {
                    "properties": {
                      "asset_path": {
                        "type": "string"
                      },
                      "bucket_id": {
                        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "asset_path",
                      "bucket_id"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data_lake"
                ],
                "title": "data_lake",
                "type": "object"
              }
            ]
          },
          "completed_at": {
            "default": null,
            "format": "date-time",
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "deployment_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "status": {
            "enum": [
              "QUEUED",
              "DEPLOYING",
              "SUCCEEDED",
              "FAILED",
              "ERROR"
            ],
            "type": "string"
          },
          "status_detail": {},
          "structure_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          }
        },
        "required": [
          "code_source",
          "created_at",
          "created_by",
          "deployment_id",
          "status",
          "structure_id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "deployments",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
deployments	[StructureDeploymentDetail ]	true	none	none
pagination	Pagination	true	none	none

ListStructureRunLogsResponseContent

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
logs	[string]	true	none	none

ListStructureRunsResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "structure_runs": {
      "items": {
        "properties": {
          "args": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "completed_at": {
            "default": null,
            "format": "date-time",
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "deployment_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "env_vars": {
            "items": {
              "properties": {
                "name": {
                  "type": "string"
                },
                "source": {
                  "enum": [
                    "secret_ref",
                    "manual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "output": {},
          "output_timestamp": {
            "format": "double",
            "type": "number"
          },
          "started_at": {
            "default": null,
            "format": "date-time",
            "type": "string",
            "nullable": true
          },
          "status": {
            "enum": [
              "QUEUED",
              "STARTING",
              "RUNNING",
              "SUCCEEDED",
              "FAILED",
              "ERROR",
              "CANCELLED"
            ],
            "type": "string"
          },
          "status_detail": {},
          "structure_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "structure_run_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "args",
          "completed_at",
          "created_at",
          "created_by",
          "started_at",
          "status",
          "structure_id",
          "structure_run_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "structure_runs"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
structure_runs	[StructureRunDetail ]	true	none	none

ListStructuresResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "structures": {
      "items": {
        "properties": {
          "code": {
            "oneOf": [
              {
                "properties": {
                  "github": {
                    "properties": {
                      "name": {
                        "maxLength": 200,
                        "minLength": 1,
                        "type": "string"
                      },
                      "owner": {
                        "maxLength": 200,
                        "minLength": 1,
                        "type": "string"
                      },
                      "push": {
                        "properties": {
                          "branch": {
                            "maxLength": 200,
                            "minLength": 1,
                            "type": "string"
                          },
                          "tag": {
                            "maxLength": 200,
                            "minLength": 1,
                            "type": "string"
                          }
                        },
                        "required": [
                          "branch"
                        ],
                        "type": "object"
                      }
                    },
                    "required": [
                      "name",
                      "owner",
                      "push"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "github"
                ],
                "title": "github",
                "type": "object"
              },
              {
                "properties": {
                  "data_lake": {
                    "properties": {
                      "asset_path": {
                        "type": "string"
                      },
                      "bucket_id": {
                        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "asset_path",
                      "bucket_id"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data_lake"
                ],
                "title": "data_lake",
                "type": "object"
              },
              {
                "properties": {
                  "default": {
                    "type": "object"
                  }
                },
                "required": [
                  "default"
                ],
                "title": "default",
                "type": "object"
              }
            ]
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "env_vars": {
            "items": {
              "properties": {
                "name": {
                  "type": "string"
                },
                "source": {
                  "enum": [
                    "secret_ref",
                    "manual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "latest_deployment_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "structure_config_file": {
            "type": "string"
          },
          "structure_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "webhook_enabled": {
            "type": "boolean"
          }
        },
        "required": [
          "code",
          "created_at",
          "created_by",
          "description",
          "env_vars",
          "latest_deployment_id",
          "name",
          "organization_id",
          "structure_id",
          "updated_at",
          "webhook_enabled"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "structures"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
structures	[StructureDetail ]	true	none	none

ListThreadsResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "threads": {
      "items": {
        "properties": {
          "alias": {
            "type": "string"
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "metadata": {
            "additionalProperties": {},
            "type": "object"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "thread_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "alias",
          "created_at",
          "created_by",
          "metadata",
          "name",
          "organization_id",
          "thread_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "threads"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
threads	[ThreadDetail ]	true	none	none

ListToolDeploymentsResponseContent

{
  "properties": {
    "deployments": {
      "items": {
        "properties": {
          "code_source": {
            "oneOf": [
              {
                "properties": {
                  "github": {
                    "properties": {
                      "commit_sha": {
                        "maxLength": 200,
                        "minLength": 1,
                        "type": "string"
                      }
                    },
                    "type": "object"
                  }
                },
                "required": [
                  "github"
                ],
                "title": "github",
                "type": "object"
              },
              {
                "properties": {
                  "data_lake": {
                    "properties": {
                      "asset_path": {
                        "type": "string"
                      },
                      "bucket_id": {
                        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "asset_path",
                      "bucket_id"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data_lake"
                ],
                "title": "data_lake",
                "type": "object"
              }
            ]
          },
          "completed_at": {
            "default": null,
            "format": "date-time",
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "deployment_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "status": {
            "enum": [
              "QUEUED",
              "DEPLOYING",
              "SUCCEEDED",
              "FAILED",
              "ERROR"
            ],
            "type": "string"
          },
          "status_detail": {},
          "tool_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          }
        },
        "required": [
          "code_source",
          "created_at",
          "created_by",
          "deployment_id",
          "status",
          "tool_id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "deployments",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
deployments	[ToolDeploymentDetail ]	true	none	none
pagination	Pagination	true	none	none

ListToolRunLogsResponseContent

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
logs	[string]	true	none	none

ListToolRunsResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "tool_runs": {
      "items": {
        "properties": {
          "completed_at": {
            "default": null,
            "format": "date-time",
            "type": "string",
            "nullable": true
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "deployment_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "env_vars": {
            "items": {
              "properties": {
                "name": {
                  "type": "string"
                },
                "source": {
                  "enum": [
                    "secret_ref",
                    "manual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "input": {},
          "output": {},
          "output_timestamp": {
            "format": "double",
            "type": "number"
          },
          "runtime_path": {
            "type": "string"
          },
          "started_at": {
            "default": null,
            "format": "date-time",
            "type": "string",
            "nullable": true
          },
          "status": {
            "enum": [
              "QUEUED",
              "STARTING",
              "RUNNING",
              "SUCCEEDED",
              "FAILED",
              "ERROR",
              "CANCELLED"
            ],
            "type": "string"
          },
          "status_detail": {},
          "tool_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "tool_run_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "completed_at",
          "created_at",
          "created_by",
          "input",
          "runtime_path",
          "started_at",
          "status",
          "tool_id",
          "tool_run_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "tool_runs"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
tool_runs	[ToolRunDetail ]	true	none	none

ListToolsResponseContent

{
  "properties": {
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    },
    "tools": {
      "items": {
        "properties": {
          "code": {
            "oneOf": [
              {
                "properties": {
                  "github": {
                    "properties": {
                      "name": {
                        "maxLength": 200,
                        "minLength": 1,
                        "type": "string"
                      },
                      "owner": {
                        "maxLength": 200,
                        "minLength": 1,
                        "type": "string"
                      },
                      "push": {
                        "properties": {
                          "branch": {
                            "maxLength": 200,
                            "minLength": 1,
                            "type": "string"
                          },
                          "tag": {
                            "maxLength": 200,
                            "minLength": 1,
                            "type": "string"
                          }
                        },
                        "required": [
                          "branch"
                        ],
                        "type": "object"
                      }
                    },
                    "required": [
                      "name",
                      "owner",
                      "push"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "github"
                ],
                "title": "github",
                "type": "object"
              },
              {
                "properties": {
                  "data_lake": {
                    "properties": {
                      "asset_path": {
                        "type": "string"
                      },
                      "bucket_id": {
                        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                        "type": "string"
                      }
                    },
                    "required": [
                      "asset_path",
                      "bucket_id"
                    ],
                    "type": "object"
                  }
                },
                "required": [
                  "data_lake"
                ],
                "title": "data_lake",
                "type": "object"
              },
              {
                "properties": {
                  "default": {
                    "type": "object"
                  }
                },
                "required": [
                  "default"
                ],
                "title": "default",
                "type": "object"
              }
            ]
          },
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "env_vars": {
            "items": {
              "properties": {
                "name": {
                  "type": "string"
                },
                "source": {
                  "enum": [
                    "secret_ref",
                    "manual"
                  ],
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "type": "object"
            },
            "type": "array"
          },
          "latest_deployment_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "tool_config_file": {
            "type": "string"
          },
          "tool_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "code",
          "created_at",
          "created_by",
          "description",
          "env_vars",
          "latest_deployment_id",
          "name",
          "organization_id",
          "tool_id",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "pagination",
    "tools"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
pagination	Pagination	true	none	none
tools	[ToolDetail ]	true	none	none

ListUserInvitesResponseContent

{
  "properties": {
    "invites": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "expires_at": {
            "format": "date-time",
            "type": "string"
          },
          "invite_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "responded_at": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "enum": [
              "ACCEPTED",
              "EXPIRED",
              "PENDING",
              "REJECTED"
            ],
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "created_by",
          "email",
          "expires_at",
          "invite_id",
          "organization_id",
          "status"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "pagination": {
      "properties": {
        "next_page": {
          "type": "number"
        },
        "page_number": {
          "type": "number"
        },
        "page_size": {
          "type": "number"
        },
        "previous_page": {
          "type": "number"
        },
        "total_count": {
          "type": "number"
        },
        "total_pages": {
          "type": "number"
        }
      },
      "required": [
        "page_number",
        "page_size",
        "total_count",
        "total_pages"
      ],
      "type": "object"
    }
  },
  "required": [
    "invites",
    "pagination"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
invites	[InviteDetail ]	true	none	none
pagination	Pagination	true	none	none

ListUsersResponseContent

{
  "properties": {
    "users": {
      "items": {
        "properties": {
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organizations": {
            "items": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            },
            "type": "array"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          },
          "user_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          }
        },
        "required": [
          "created_at",
          "email",
          "organizations",
          "updated_at",
          "user_id"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
users	[UserDetail ]	false	none	none

MessageContent

{
  "properties": {
    "artifact": {
      "properties": {
        "id": {
          "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
          "type": "string"
        },
        "meta": {},
        "name": {
          "type": "string"
        },
        "reference": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "type",
        "value"
      ],
      "type": "object"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "artifact",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
artifact	Artifact	true	none	none
type	string	true	none	none

MessageDetail

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "index": {
      "type": "number"
    },
    "input": {
      "type": "string"
    },
    "message_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    },
    "thread_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "index",
    "input",
    "message_id",
    "metadata",
    "output",
    "thread_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	Metadata	true	none	none
output	string	true	none	none
thread_id	string	true	none	none
updated_at	string(date-time)	true	none	none

MessageInput

{
  "properties": {
    "input": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    }
  },
  "required": [
    "input",
    "output"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
input	string	true	none	none
metadata	Metadata	false	none	none
output	string	true	none	none

Meta

{
  "additionalProperties": {
    "type": "string"
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	string	false	none	none

Metadata

{
  "additionalProperties": {},
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	any	false	none	none

ModelDetail

{
  "properties": {
    "default": {
      "type": "boolean"
    },
    "description": {
      "type": "string"
    },
    "model_name": {
      "type": "string"
    },
    "model_type": {
      "enum": [
        "chat",
        "embedding",
        "rerank",
        "image_generation",
        "unknown"
      ],
      "type": "string"
    }
  },
  "required": [
    "default",
    "model_name",
    "model_type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
default	boolean	true	none	none
description	string	false	none	none
model_name	string	true	none	none
model_type	ModelType	true	none	none

ModelTokenCounts

{
  "properties": {
    "input": {
      "format": "float",
      "type": "number"
    },
    "output": {
      "format": "float",
      "type": "number"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
input	number(float)	false	none	none
output	number(float)	false	none	none

ModelTokenCountsMap

{
  "additionalProperties": {
    "properties": {
      "input": {
        "format": "float",
        "type": "number"
      },
      "output": {
        "format": "float",
        "type": "number"
      }
    },
    "type": "object"
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
additionalProperties	ModelTokenCounts	false	none	none

ModelType

{
  "enum": [
    "chat",
    "embedding",
    "rerank",
    "image_generation",
    "unknown"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	chat
anonymous	embedding
anonymous	rerank
anonymous	image_generation
anonymous	unknown

ObservabilityEvent

{
  "properties": {
    "attributes": {},
    "name": {
      "type": "string"
    },
    "timestamp": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "attributes",
    "name",
    "timestamp"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
attributes	any	true	none	none
name	string	true	none	none
timestamp	string(date-time)	true	none	none

OrganizationDetail

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "default_bucket_id": {
      "type": "string"
    },
    "description": {
      "maxLength": 2000,
      "type": "string"
    },
    "entitlement": {
      "allOf": [
        {
          "enum": [
            "FREE",
            "PAID",
            "PARTNER",
            "UNPAID",
            "EXPIRED"
          ],
          "type": "string"
        },
        {
          "default": "FREE"
        }
      ]
    },
    "model_config": {
      "properties": {
        "default_chat_model": {
          "type": "string"
        },
        "default_embedding_model": {
          "type": "string"
        },
        "default_image_generation_model": {
          "type": "string"
        },
        "default_rerank_model": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "default_bucket_id",
    "description",
    "entitlement",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

Name	Type	Required	Restrictions	Description
» anonymous	Entitlement	false	none	none

and

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

continued

Name	Type	Required	Restrictions	Description
model_config	OrganizationModelConfig	false	none	none
name	string	true	none	none
organization_id	string	true	none	none
updated_at	string(date-time)	true	none	none

OrganizationModelConfig

{
  "properties": {
    "default_chat_model": {
      "type": "string"
    },
    "default_embedding_model": {
      "type": "string"
    },
    "default_image_generation_model": {
      "type": "string"
    },
    "default_rerank_model": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
email	string	true	none	none
user_id	string	true	none	none

PGAIKnowledgeBaseKnowledgeBaseDetail

{
  "properties": {
    "knowledge_base_name": {
      "type": "string"
    },
    "query_schema": {}
  },
  "required": [
    "knowledge_base_name",
    "query_schema"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
knowledge_base_name	string	true	none	none
query_schema	any	true	none	none

PGAIKnowledgeBaseKnowledgeBaseInput

{
  "type": "object"
}

Properties

• None*

PGVectorKnowledgeBaseDetail

{
  "properties": {
    "connection_string": {
      "type": "string"
    },
    "embedding_model": {
      "type": "string"
    },
    "query_schema": {},
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "required": [
    "connection_string",
    "embedding_model",
    "query_schema",
    "use_default_embedding_model"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "enum": [
    "1m",
    "1h",
    "1d",
    "1w"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	1m
anonymous	1h
anonymous	1d
anonymous	1w

QueryKnowledgeBaseRequestContent

{
  "properties": {
    "query": {
      "type": "string"
    },
    "query_args": {}
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
query	string	false	none	none
query_args	any	false	none	none

QueryKnowledgeBaseResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "entries": {
      "items": {
        "properties": {
          "id": {
            "type": "string"
          },
          "meta": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "namespace": {
            "type": "string"
          },
          "score": {
            "format": "float",
            "type": "number"
          },
          "vector": {
            "items": {
              "format": "float",
              "type": "number"
            },
            "type": "array"
          }
        },
        "required": [
          "id",
          "score"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "knowledge_base_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "knowledge_base_query_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "query": {
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "entries",
    "knowledge_base_id",
    "knowledge_base_query_id",
    "query"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
entries	[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

{
  "properties": {
    "query": {
      "type": "string"
    },
    "retriever_components_query_args": {}
  },
  "required": [
    "query"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
query	string	true	none	none
retriever_components_query_args	any	false	none	none

QueryRetrieverResponseContent

{
  "properties": {
    "outputs": {
      "items": {},
      "type": "array"
    }
  },
  "required": [
    "outputs"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
outputs	[any]	true	none	none

RespondToInviteRequestContent

{
  "properties": {
    "response": {
      "enum": [
        "ACCEPTED",
        "REJECTED"
      ],
      "type": "string"
    }
  },
  "required": [
    "response"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
response	InviteResponseStatus	true	none	none

RetrieverComponentDetail

{
  "properties": {
    "config": {},
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "retriever_component_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "config",
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "retriever_component_id",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
config	any	false	none	none
description	string	false	none	none
name	string	true	none	none
type	string	true	none	none

RetrieverDetail

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "retriever_components": {
      "items": {
        "properties": {
          "config": {},
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "retriever_component_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "config",
          "created_at",
          "created_by",
          "name",
          "organization_id",
          "retriever_component_id",
          "type",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "retriever_components_schema": {},
    "retriever_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "retriever_components",
    "retriever_components_schema",
    "retriever_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[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

{
  "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

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
metadata	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

{
  "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

Name	Type	Required	Restrictions	Description
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	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

{
  "properties": {
    "active_count": {
      "type": "number"
    },
    "total_count": {
      "type": "number"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
active_count	number	false	none	none
total_count	number	false	none	none

RunDurationGauge

{
  "properties": {
    "activity_durations": {
      "items": {
        "properties": {
          "activity_type": {
            "type": "string"
          },
          "seconds": {
            "type": "number"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "total_seconds": {
      "type": "number"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
activity_durations	[ActivityDuration ]	false	none	none
total_seconds	number	false	none	none

S3ConnectorDetail

{
  "properties": {
    "aws_access_key_id": {
      "type": "string"
    },
    "uris": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "aws_access_key_id",
    "uris"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
aws_access_key_id	string	true	none	none
uris	[string]	true	none	none

S3ConnectorInput

{
  "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

Name	Type	Required	Restrictions	Description
aws_access_key_id	string	true	none	none
aws_secret_access_key	string	true	none	none
uris	[string]	true	none	none

SearchKnowledgeBaseRequestContent

{
  "properties": {
    "query": {
      "type": "string"
    },
    "query_args": {}
  },
  "required": [
    "query"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
query	string	true	none	none
query_args	any	false	none	none

SearchKnowledgeBaseResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "knowledge_base_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "knowledge_base_search_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "query": {
      "type": "string"
    },
    "result": {
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "knowledge_base_id",
    "knowledge_base_search_id",
    "query",
    "result"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
errors	[any]	false	none	none
type	string	true	none	none

SlackDetail

{
  "properties": {
    "app_description": {
      "type": "string"
    },
    "app_display_name": {
      "type": "string"
    },
    "app_manifest": {},
    "app_name": {
      "type": "string"
    },
    "bot_token_secret_ref": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "signing_secret_secret_ref": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    }
  },
  "required": [
    "app_description",
    "app_display_name",
    "app_manifest",
    "app_name",
    "bot_token_secret_ref",
    "signing_secret_secret_ref"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
attributes	any	true	none	none
end_time	string(date-time)	true	none	none
events	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	SpanStatus	true	none	none
trace_id	string	true	none	none

SpanStatus

{
  "enum": [
    "UNSET",
    "OK",
    "ERROR"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	UNSET
anonymous	OK
anonymous	ERROR

StreamMessageContent

{
  "properties": {
    "artifact": {
      "properties": {
        "id": {
          "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
          "type": "string"
        },
        "meta": {},
        "name": {
          "type": "string"
        },
        "reference": {
          "type": "string"
        },
        "type": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "id",
        "name",
        "type",
        "value"
      ],
      "type": "object"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "artifact",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
artifact	Artifact	true	none	none
type	string	true	none	none

StructureCode

{
  "oneOf": [
    {
      "properties": {
        "github": {
          "properties": {
            "name": {
              "maxLength": 200,
              "minLength": 1,
              "type": "string"
            },
            "owner": {
              "maxLength": 200,
              "minLength": 1,
              "type": "string"
            },
            "push": {
              "properties": {
                "branch": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "tag": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "branch"
              ],
              "type": "object"
            }
          },
          "required": [
            "name",
            "owner",
            "push"
          ],
          "type": "object"
        }
      },
      "required": [
        "github"
      ],
      "title": "github",
      "type": "object"
    },
    {
      "properties": {
        "data_lake": {
          "properties": {
            "asset_path": {
              "type": "string"
            },
            "bucket_id": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            }
          },
          "required": [
            "asset_path",
            "bucket_id"
          ],
          "type": "object"
        }
      },
      "required": [
        "data_lake"
      ],
      "title": "data_lake",
      "type": "object"
    },
    {
      "properties": {
        "default": {
          "type": "object"
        }
      },
      "required": [
        "default"
      ],
      "title": "default",
      "type": "object"
    }
  ]
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» github	GithubStructureCode	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data_lake	DataLakeStructureCode	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» default	DefaultStructureCode	true	none	none

StructureConnectorDetail

{
  "properties": {
    "args": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "structure_id": {
      "type": "string"
    }
  },
  "required": [
    "structure_id"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
args	[string]	false	none	none
structure_id	string	true	none	none

StructureConnectorInput

{
  "properties": {
    "args": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "structure_id": {
      "type": "string"
    }
  },
  "required": [
    "structure_id"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
args	[string]	false	none	none
structure_id	string	true	none	none

StructureDeploymentDetail

{
  "properties": {
    "code_source": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "commit_sha": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        }
      ]
    },
    "completed_at": {
      "default": null,
      "format": "date-time",
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "status": {
      "enum": [
        "QUEUED",
        "DEPLOYING",
        "SUCCEEDED",
        "FAILED",
        "ERROR"
      ],
      "type": "string"
    },
    "status_detail": {},
    "structure_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    }
  },
  "required": [
    "code_source",
    "created_at",
    "created_by",
    "deployment_id",
    "status",
    "structure_id"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code_source	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	DeploymentStatus	true	none	none
status_detail	any	false	none	none
structure_id	string	true	none	none

StructureDetail

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "latest_deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_config_file": {
      "type": "string"
    },
    "structure_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "webhook_enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "code",
    "created_at",
    "created_by",
    "description",
    "env_vars",
    "latest_deployment_id",
    "name",
    "organization_id",
    "structure_id",
    "updated_at",
    "webhook_enabled"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
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	[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	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

{
  "enum": [
    "QUEUED",
    "STARTING",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	QUEUED
anonymous	STARTING
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	ERROR
anonymous	CANCELLED

StructuredColumnDetail

{
  "properties": {
    "column_name": {
      "type": "string"
    },
    "sql_type": {
      "type": "string"
    }
  },
  "required": [
    "column_name",
    "sql_type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
column_name	string	true	none	none
sql_type	string	true	none	none

StructuredColumnInput

{
  "properties": {
    "column_name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "sql_type": {
      "type": "string"
    }
  },
  "required": [
    "column_name",
    "description",
    "sql_type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
column_name	string	true	none	none
description	string	true	none	none
sql_type	string	true	none	none

ThreadDetail

{
  "properties": {
    "alias": {
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "thread_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "alias",
    "created_at",
    "created_by",
    "metadata",
    "name",
    "organization_id",
    "thread_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
alias	string	true	none	none
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
metadata	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

{
  "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

Name	Type	Required	Restrictions	Description
by_model	ModelTokenCountsMap	false	none	none
input	number(float)	false	none	none
output	number(float)	false	none	none

ToolCode

{
  "oneOf": [
    {
      "properties": {
        "github": {
          "properties": {
            "name": {
              "maxLength": 200,
              "minLength": 1,
              "type": "string"
            },
            "owner": {
              "maxLength": 200,
              "minLength": 1,
              "type": "string"
            },
            "push": {
              "properties": {
                "branch": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "tag": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                }
              },
              "required": [
                "branch"
              ],
              "type": "object"
            }
          },
          "required": [
            "name",
            "owner",
            "push"
          ],
          "type": "object"
        }
      },
      "required": [
        "github"
      ],
      "title": "github",
      "type": "object"
    },
    {
      "properties": {
        "data_lake": {
          "properties": {
            "asset_path": {
              "type": "string"
            },
            "bucket_id": {
              "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
              "type": "string"
            }
          },
          "required": [
            "asset_path",
            "bucket_id"
          ],
          "type": "object"
        }
      },
      "required": [
        "data_lake"
      ],
      "title": "data_lake",
      "type": "object"
    },
    {
      "properties": {
        "default": {
          "type": "object"
        }
      },
      "required": [
        "default"
      ],
      "title": "default",
      "type": "object"
    }
  ]
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» github	GithubToolCode	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» data_lake	DataLakeToolCode	true	none	none

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» default	DefaultToolCode	true	none	none

ToolDeploymentDetail

{
  "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

Name	Type	Required	Restrictions	Description
code_source	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	DeploymentStatus	true	none	none
status_detail	any	false	none	none
tool_id	string	true	none	none

ToolDetail

{
  "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

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
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	[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	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

{
  "enum": [
    "QUEUED",
    "STARTING",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	QUEUED
anonymous	STARTING
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	ERROR
anonymous	CANCELLED

TransformDetail

{
  "properties": {
    "structure": {
      "properties": {
        "args": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "structure_id": {
          "type": "string"
        }
      },
      "required": [
        "structure_id"
      ],
      "type": "object"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
structure	StructureConnectorDetail	false	none	none

TransformInput

{
  "properties": {
    "structure": {
      "properties": {
        "args": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "structure_id": {
          "type": "string"
        }
      },
      "required": [
        "structure_id"
      ],
      "type": "object"
    }
  },
  "required": [
    "structure"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
structure	StructureConnectorInput	true	none	none

UnstructuredColumnDetail

{
  "properties": {
    "column_name": {
      "type": "string"
    }
  },
  "required": [
    "column_name"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
column_name	string	true	none	none

UnstructuredColumnInput

{
  "properties": {
    "column_name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "column_name",
    "description"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
column_name	string	true	none	none
description	string	true	none	none

UpdateApiKeyRequestContent

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none

UpdateApiKeyResponseContent

{
  "properties": {
    "active": {
      "type": "boolean"
    },
    "api_key_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "last_used": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "active",
    "api_key_id",
    "created_at",
    "created_by",
    "last_used",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none

UpdateBucketResponseContent

{
  "properties": {
    "bucket_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "bucket_id",
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
config	DataConnectorConfigInputUnion	false	none	none
description	string	false	none	none
name	string	false	none	none
schedule_expression	string	false	none	none

UpdateDataConnectorResponseContent

{
  "properties": {
    "config": {
      "oneOf": [
        {
          "properties": {
            "confluence": {
              "properties": {
                "atlassian_email": {
                  "type": "string"
                },
                "domain": {
                  "type": "string"
                }
              },
              "required": [
                "atlassian_email",
                "domain"
              ],
              "type": "object"
            }
          },
          "required": [
            "confluence"
          ],
          "title": "confluence",
          "type": "object"
        },
        {
          "properties": {
            "google_drive": {
              "properties": {
                "access_token": {
                  "type": "string"
                },
                "file_ids": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "access_token",
                "file_ids"
              ],
              "type": "object"
            }
          },
          "required": [
            "google_drive"
          ],
          "title": "google_drive",
          "type": "object"
        },
        {
          "properties": {
            "webscraper": {
              "properties": {
                "urls": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "urls"
              ],
              "type": "object"
            }
          },
          "required": [
            "webscraper"
          ],
          "title": "webscraper",
          "type": "object"
        },
        {
          "properties": {
            "structure": {
              "properties": {
                "args": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "structure_id": {
                  "type": "string"
                }
              },
              "required": [
                "structure_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "structure"
          ],
          "title": "structure",
          "type": "object"
        },
        {
          "properties": {
            "s3": {
              "properties": {
                "aws_access_key_id": {
                  "type": "string"
                },
                "uris": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              },
              "required": [
                "aws_access_key_id",
                "uris"
              ],
              "type": "object"
            }
          },
          "required": [
            "s3"
          ],
          "title": "s3",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_paths": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                },
                "bucket_id": {
                  "type": "string"
                }
              },
              "required": [
                "asset_paths",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "data_connector_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "data_job_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "schedule_expression": {
      "type": "string"
    },
    "transforms": {
      "items": {
        "properties": {
          "structure": {
            "properties": {
              "args": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "structure_id": {
                "type": "string"
              }
            },
            "required": [
              "structure_id"
            ],
            "type": "object"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "config",
    "created_at",
    "created_by",
    "data_connector_id",
    "name",
    "organization_id",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
config	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	[TransformDetail ]	false	none	none
type	string	true	none	none
updated_at	string(date-time)	true	none	none

UpdateFunctionRequestContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "description": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "function_config_file": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	DataLakeFunctionCode	false	none	none
description	string	false	none	none
env_vars	[EnvVar ]	false	none	none
function_config_file	string	false	none	none
name	string	false	none	none

UpdateFunctionResponseContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "function_config_file": {
      "type": "string"
    },
    "function_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "latest_deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "code",
    "created_at",
    "created_by",
    "description",
    "env_vars",
    "function_id",
    "latest_deployment_id",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	false	none	none
config	IntegrationConfigInputUnion	false	none	none
description	string	false	none	none
name	string	false	none	none
structure_ids	[string]	false	none	none
type	IntegrationType	false	none	none

UpdateIntegrationResponseContent

{
  "properties": {
    "assistant_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "config": {
      "oneOf": [
        {
          "properties": {
            "slack": {
              "properties": {
                "app_description": {
                  "type": "string"
                },
                "app_display_name": {
                  "type": "string"
                },
                "app_manifest": {},
                "app_name": {
                  "type": "string"
                },
                "bot_token_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                },
                "signing_secret_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "app_description",
                "app_display_name",
                "app_manifest",
                "app_name",
                "bot_token_secret_ref",
                "signing_secret_secret_ref"
              ],
              "type": "object"
            }
          },
          "required": [
            "slack"
          ],
          "title": "slack",
          "type": "object"
        },
        {
          "properties": {
            "github_app": {
              "properties": {
                "app_id": {
                  "type": "string"
                },
                "integration_endpoint": {
                  "type": "string"
                },
                "private_key_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                },
                "webhook_secret_ref": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "app_id",
                "integration_endpoint",
                "private_key_secret_ref",
                "webhook_secret_ref"
              ],
              "type": "object"
            }
          },
          "required": [
            "github_app"
          ],
          "title": "github_app",
          "type": "object"
        },
        {
          "properties": {
            "webhook": {
              "properties": {
                "disable_api_key_param": {
                  "type": "boolean"
                },
                "integration_endpoint": {
                  "type": "string"
                }
              },
              "required": [
                "disable_api_key_param",
                "integration_endpoint"
              ],
              "type": "object"
            }
          },
          "required": [
            "webhook"
          ],
          "title": "webhook",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "integration_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "type": {
      "enum": [
        "slack",
        "github_app",
        "webhook"
      ],
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "assistant_ids",
    "config",
    "created_at",
    "created_by",
    "description",
    "integration_id",
    "name",
    "organization_id",
    "structure_ids",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	true	none	none
config	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	IntegrationType	true	none	none
updated_at	string(date-time)	true	none	none

UpdateKnowledgeBaseRequestContent

{
  "properties": {
    "asset_paths": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "config": {
      "oneOf": [
        {
          "properties": {
            "pg_vector": {
              "properties": {
                "connection_string": {
                  "type": "string"
                },
                "embedding_model": {
                  "type": "string"
                },
                "password": {
                  "type": "string"
                },
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "connection_string",
                "password"
              ],
              "type": "object"
            }
          },
          "required": [
            "pg_vector"
          ],
          "title": "pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "gtc_pg_vector": {
              "properties": {
                "embedding_model": {
                  "type": "string"
                },
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "type": "object"
            }
          },
          "required": [
            "gtc_pg_vector"
          ],
          "title": "gtc_pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "gtc_hybrid_sql_pg_vector": {
              "properties": {
                "embedding_model": {
                  "type": "string"
                },
                "structured_columns": {
                  "items": {
                    "properties": {
                      "column_name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      },
                      "sql_type": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "column_name",
                      "description",
                      "sql_type"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "unstructured_columns": {
                  "items": {
                    "properties": {
                      "column_name": {
                        "type": "string"
                      },
                      "description": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "column_name",
                      "description"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "structured_columns",
                "unstructured_columns"
              ],
              "type": "object"
            }
          },
          "required": [
            "gtc_hybrid_sql_pg_vector"
          ],
          "title": "gtc_hybrid_sql_pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "pgai_knowledge_base": {
              "type": "object"
            }
          },
          "required": [
            "pgai_knowledge_base"
          ],
          "title": "pgai_knowledge_base",
          "type": "object"
        }
      ]
    },
    "description": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "embedding_model": {
      "enum": [
        "text-embedding-ada-002",
        "text-embedding-3-small"
      ],
      "type": "string"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "schedule_expression": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "transforms": {
      "items": {
        "properties": {
          "structure": {
            "properties": {
              "args": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "structure_id": {
                "type": "string"
              }
            },
            "required": [
              "structure_id"
            ],
            "type": "object"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "required": [
    "config",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
asset_paths	[string]	false	none	none
config	KnowledgeBaseConfigInputUnion	true	none	none
description	string	false	none	none
embedding_model	EmbeddingModel	false	none	none
name	string	false	none	none
schedule_expression	string	false	none	none
transforms	[TransformDetail ]	false	none	none
type	string	true	none	none
use_default_embedding_model	boolean	false	none	none

UpdateKnowledgeBaseResponseContent

{
  "properties": {
    "asset_paths": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "config": {
      "oneOf": [
        {
          "properties": {
            "pg_vector": {
              "properties": {
                "connection_string": {
                  "type": "string"
                },
                "embedding_model": {
                  "type": "string"
                },
                "query_schema": {},
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "connection_string",
                "embedding_model",
                "query_schema",
                "use_default_embedding_model"
              ],
              "type": "object"
            }
          },
          "required": [
            "pg_vector"
          ],
          "title": "pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "gtc_pg_vector": {
              "properties": {
                "embedding_model": {
                  "type": "string"
                },
                "query_schema": {},
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "embedding_model",
                "query_schema",
                "use_default_embedding_model"
              ],
              "type": "object"
            }
          },
          "required": [
            "gtc_pg_vector"
          ],
          "title": "gtc_pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "gtc_hybrid_sql_pg_vector": {
              "properties": {
                "embedding_model": {
                  "type": "string"
                },
                "query_schema": {},
                "structured_columns": {
                  "items": {
                    "properties": {
                      "column_name": {
                        "type": "string"
                      },
                      "sql_type": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "column_name",
                      "sql_type"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "unstructured_columns": {
                  "items": {
                    "properties": {
                      "column_name": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "column_name"
                    ],
                    "type": "object"
                  },
                  "type": "array"
                },
                "use_default_embedding_model": {
                  "type": "boolean"
                }
              },
              "required": [
                "embedding_model",
                "query_schema",
                "structured_columns",
                "unstructured_columns",
                "use_default_embedding_model"
              ],
              "type": "object"
            }
          },
          "required": [
            "gtc_hybrid_sql_pg_vector"
          ],
          "title": "gtc_hybrid_sql_pg_vector",
          "type": "object"
        },
        {
          "properties": {
            "pgai_knowledge_base": {
              "properties": {
                "knowledge_base_name": {
                  "type": "string"
                },
                "query_schema": {}
              },
              "required": [
                "knowledge_base_name",
                "query_schema"
              ],
              "type": "object"
            }
          },
          "required": [
            "pgai_knowledge_base"
          ],
          "title": "pgai_knowledge_base",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "embedding_model": {
      "enum": [
        "text-embedding-ada-002",
        "text-embedding-3-small"
      ],
      "type": "string"
    },
    "knowledge_base_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "schedule_expression": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "transforms": {
      "items": {
        "properties": {
          "structure": {
            "properties": {
              "args": {
                "items": {
                  "type": "string"
                },
                "type": "array"
              },
              "structure_id": {
                "type": "string"
              }
            },
            "required": [
              "structure_id"
            ],
            "type": "object"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "required": [
    "asset_paths",
    "config",
    "created_at",
    "created_by",
    "knowledge_base_id",
    "name",
    "organization_id",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
asset_paths	[string]	true	none	none
config	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	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
data_connector_ids	[string]	true	none	none
description	string	false	none	none
knowledge_base_configs	[KnowledgeBaseConfigInputUnion ]	true	none	none
name	string	true	none	none

UpdateLibraryResponseContent

{
  "properties": {
    "assistant_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "data_connector_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "description": {
      "type": "string"
    },
    "knowledge_base_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "library_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "retriever_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "assistant_id",
    "created_at",
    "created_by",
    "data_connector_ids",
    "knowledge_base_ids",
    "library_id",
    "name",
    "organization_id",
    "retriever_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "input": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
input	string	false	none	none
metadata	Metadata	false	none	none
output	string	false	none	none

UpdateMessageResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "index": {
      "type": "number"
    },
    "input": {
      "type": "string"
    },
    "message_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    },
    "thread_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "index",
    "input",
    "message_id",
    "metadata",
    "output",
    "thread_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	Metadata	true	none	none
output	string	true	none	none
thread_id	string	true	none	none
updated_at	string(date-time)	true	none	none

UpdateOrganizationRequestContent

{
  "properties": {
    "model_config": {
      "properties": {
        "default_chat_model": {
          "type": "string"
        },
        "default_embedding_model": {
          "type": "string"
        },
        "default_image_generation_model": {
          "type": "string"
        },
        "default_rerank_model": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
model_config	OrganizationModelConfig	false	none	none
name	string	false	none	none

UpdateOrganizationResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "default_bucket_id": {
      "type": "string"
    },
    "description": {
      "maxLength": 2000,
      "type": "string"
    },
    "entitlement": {
      "allOf": [
        {
          "enum": [
            "FREE",
            "PAID",
            "PARTNER",
            "UNPAID",
            "EXPIRED"
          ],
          "type": "string"
        },
        {
          "default": "FREE"
        }
      ]
    },
    "model_config": {
      "properties": {
        "default_chat_model": {
          "type": "string"
        },
        "default_embedding_model": {
          "type": "string"
        },
        "default_image_generation_model": {
          "type": "string"
        },
        "default_rerank_model": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "default_bucket_id",
    "description",
    "entitlement",
    "name",
    "organization_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

Name	Type	Required	Restrictions	Description
» anonymous	Entitlement	false	none	none

and

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	none

continued

Name	Type	Required	Restrictions	Description
model_config	OrganizationModelConfig	false	none	none
name	string	true	none	none
organization_id	string	true	none	none
updated_at	string(date-time)	true	none	none

UpdateRetrieverComponentRequestContent

{
  "properties": {
    "config": {},
    "description": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "config",
    "type"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
config	any	true	none	none
description	string	false	none	none
name	string	false	none	none
type	string	true	none	none

UpdateRetrieverComponentResponseContent

{
  "properties": {
    "config": {},
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "retriever_component_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "config",
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "retriever_component_id",
    "type",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
description	string	false	none	none
name	string	false	none	none
retriever_component_ids	[string]	false	none	none
retriever_components	[RetrieverComponentInput ]	false	none	none

UpdateRetrieverResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "retriever_components": {
      "items": {
        "properties": {
          "config": {},
          "created_at": {
            "format": "date-time",
            "type": "string"
          },
          "created_by": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "organization_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "retriever_component_id": {
            "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "updated_at": {
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "config",
          "created_at",
          "created_by",
          "name",
          "organization_id",
          "retriever_component_id",
          "type",
          "updated_at"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "retriever_components_schema": {},
    "retriever_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "name",
    "organization_id",
    "retriever_components",
    "retriever_components_schema",
    "retriever_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	[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

{
  "properties": {
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "rule": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
metadata	Metadata	false	none	none
name	string	false	none	none
rule	string	false	none	none

UpdateRuleResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "rule": {
      "type": "string"
    },
    "rule_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "created_by",
    "metadata",
    "name",
    "organization_id",
    "rule",
    "rule_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
metadata	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

{
  "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

Name	Type	Required	Restrictions	Description
alias	string	false	none	none
description	string	false	none	none
metadata	Metadata	false	none	none
name	string	false	none	none
rule_ids	[string]	false	none	none

UpdateRulesetResponseContent

{
  "properties": {
    "alias": {
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "rule_ids": {
      "items": {
        "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
        "type": "string"
      },
      "type": "array"
    },
    "ruleset_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "alias",
    "created_at",
    "created_by",
    "description",
    "metadata",
    "name",
    "organization_id",
    "rule_ids",
    "ruleset_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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	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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "value": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
value	string	false	none	none

UpdateSecretResponseContent

{
  "properties": {
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "last_used": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "secret_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "created_at",
    "last_used",
    "name",
    "organization_id",
    "secret_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
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

{
  "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

Name	Type	Required	Restrictions	Description
code	DataLakeStructureCode	false	none	none
description	string	false	none	none
env_vars	[EnvVar ]	false	none	none
name	string	false	none	none
structure_config_file	string	false	none	none
webhook_enabled	boolean	false	none	none

UpdateStructureResponseContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "latest_deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "structure_config_file": {
      "type": "string"
    },
    "structure_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    },
    "webhook_enabled": {
      "type": "boolean"
    }
  },
  "required": [
    "code",
    "created_at",
    "created_by",
    "description",
    "env_vars",
    "latest_deployment_id",
    "name",
    "organization_id",
    "structure_id",
    "updated_at",
    "webhook_enabled"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
alias	string	false	none	none
messages	[MessageInput ]	false	none	none
metadata	Metadata	false	none	none
name	string	false	none	none

UpdateThreadResponseContent

{
  "properties": {
    "alias": {
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "thread_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "alias",
    "created_at",
    "created_by",
    "metadata",
    "name",
    "organization_id",
    "thread_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
alias	string	true	none	none
created_at	string(date-time)	true	none	none
created_by	string	true	none	none
metadata	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

{
  "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

Name	Type	Required	Restrictions	Description
code	DataLakeToolCode	false	none	none
description	string	false	none	none
env_vars	[EnvVar ]	false	none	none
name	string	false	none	none
tool_config_file	string	false	none	none

UpdateToolResponseContent

{
  "properties": {
    "code": {
      "oneOf": [
        {
          "properties": {
            "github": {
              "properties": {
                "name": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "owner": {
                  "maxLength": 200,
                  "minLength": 1,
                  "type": "string"
                },
                "push": {
                  "properties": {
                    "branch": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    },
                    "tag": {
                      "maxLength": 200,
                      "minLength": 1,
                      "type": "string"
                    }
                  },
                  "required": [
                    "branch"
                  ],
                  "type": "object"
                }
              },
              "required": [
                "name",
                "owner",
                "push"
              ],
              "type": "object"
            }
          },
          "required": [
            "github"
          ],
          "title": "github",
          "type": "object"
        },
        {
          "properties": {
            "data_lake": {
              "properties": {
                "asset_path": {
                  "type": "string"
                },
                "bucket_id": {
                  "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
                  "type": "string"
                }
              },
              "required": [
                "asset_path",
                "bucket_id"
              ],
              "type": "object"
            }
          },
          "required": [
            "data_lake"
          ],
          "title": "data_lake",
          "type": "object"
        },
        {
          "properties": {
            "default": {
              "type": "object"
            }
          },
          "required": [
            "default"
          ],
          "title": "default",
          "type": "object"
        }
      ]
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "created_by": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "env_vars": {
      "items": {
        "properties": {
          "name": {
            "type": "string"
          },
          "source": {
            "enum": [
              "secret_ref",
              "manual"
            ],
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "latest_deployment_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "organization_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "tool_config_file": {
      "type": "string"
    },
    "tool_id": {
      "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$",
      "type": "string"
    },
    "updated_at": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "code",
    "created_at",
    "created_by",
    "description",
    "env_vars",
    "latest_deployment_id",
    "name",
    "organization_id",
    "tool_id",
    "updated_at"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
code	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	[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

{
  "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

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "disable_api_key_param": {
      "type": "boolean"
    },
    "integration_endpoint": {
      "type": "string"
    }
  },
  "required": [
    "disable_api_key_param",
    "integration_endpoint"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
disable_api_key_param	boolean	true	none	none
integration_endpoint	string	true	none	none

WebhookInput

{
  "properties": {
    "disable_api_key_param": {
      "type": "boolean"
    }
  },
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
disable_api_key_param	boolean	false	none	none

WebscraperDetail

{
  "properties": {
    "urls": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "urls"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
urls	[string]	true	none	none

WebscraperInput

{
  "properties": {
    "urls": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "urls"
  ],
  "type": "object"
}

Properties

Name	Type	Required	Restrictions	Description
urls	[string]	true	none	none