{ "x-generated": "honey checksum:3b8468a0c0a4", "info": { "title": "Anyrow API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/v1/organizations/{organization_id}/webhooks": { "post": { "summary": "Create webhook", "tags": [ "Webhooks" ], "operationId": "webhook.create", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationsWebhookRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationsWebhookResponse201" } } }, "description": "created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "get": { "summary": "List webhooks", "tags": [ "Webhooks" ], "operationId": "webhook.list", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Opaque cursor for forward pagination. Pass the nextCursor from the previous response with the same order. Takes precedence over page when both are sent.", "examples": [ "eyJpIjoiMDFIIiwicyI6IiIsInYiOltdfQ" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "description": "1-based page number for offset pagination. Ignored when cursor is present.", "examples": [ 1, 2 ], "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, { "in": "query", "name": "order", "required": false, "schema": { "description": "Sort keys, comma-separated, each `field[.asc|.desc][.nullsfirst|.nullslast]`; at most 3. Sortable: created_at, active. Default: created_at.desc. Nulls sort last ascending and first descending unless stated.", "examples": [ "created_at.desc", "active.asc,created_at.desc" ], "pattern": "^(?:created_at|active)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?(?:,(?:created_at|active)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?){0,2}$", "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "description": "Filter expression `field.op.value`; `,` joins conditions with AND; group with `or(...)` and `and(...)`. Fields: active (boolean: eq, ne, neq, is); created_at (number: eq, ne, neq, gt, gte, lt, lte, in, nin, is); id (string: eq, ne, neq, like, ilike, in, nin, is); name (string: eq, ne, neq, like, ilike, in, nin, is). `like` is case-sensitive and `ilike` ignores ASCII case; `*` is the wildcard. `in`/`nin` take `(a,b)`; `is` takes `null` or `notnull`. At most 20 conditions, 3 nested groups, 100 in/nin values.", "examples": [ "active.eq.true", "id.ilike.*acme*", "or(active.eq.true,created_at.gte.10)" ], "type": "string" } }, { "in": "query", "name": "q", "required": false, "schema": { "description": "Free-text search over: name, url. Whitespace-separated terms must all match.", "examples": [ "acme", "acme corp" ], "type": "string", "maxLength": 200 } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "Maximum number of items per page. Defaults to 20, capped by the endpoint's maxLimit.", "examples": [ 20, 50 ], "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationsWebhooksResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/organizations/{organization_id}/webhooks/{id}": { "get": { "summary": "Get webhook", "tags": [ "Webhooks" ], "operationId": "webhook.get", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationsWebhookResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundWebhookNotFound" } } }, "description": "not_found, webhook_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "patch": { "summary": "Update webhook", "tags": [ "Webhooks" ], "operationId": "webhook.update", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationsWebhookRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOrganizationsWebhookResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundWebhookNotFound" } } }, "description": "not_found, webhook_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "delete": { "summary": "Delete webhook", "tags": [ "Webhooks" ], "operationId": "webhook.delete", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationsWebhookResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundWebhookNotFound" } } }, "description": "not_found, webhook_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/organizations/{organization_id}/webhooks/{id}/deliveries": { "get": { "summary": "List webhook deliveries", "tags": [ "Webhooks" ], "operationId": "webhook.deliveries", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Opaque cursor for forward pagination. Pass the nextCursor from the previous response with the same order. Takes precedence over page when both are sent.", "examples": [ "eyJpIjoiMDFIIiwicyI6IiIsInYiOltdfQ" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "description": "1-based page number for offset pagination. Ignored when cursor is present.", "examples": [ 1, 2 ], "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, { "in": "query", "name": "order", "required": false, "schema": { "description": "Sort keys, comma-separated, each `field[.asc|.desc][.nullsfirst|.nullslast]`; at most 3. Sortable: created_at, status. Default: created_at.desc. Nulls sort last ascending and first descending unless stated.", "examples": [ "created_at.desc", "status.asc,created_at.desc" ], "pattern": "^(?:created_at|status)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?(?:,(?:created_at|status)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?){0,2}$", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "Maximum number of items per page. Defaults to 20, capped by the endpoint's maxLimit.", "examples": [ 20, 50 ], "type": "integer", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "event", "required": false, "schema": { "type": "string", "enum": [ "batch.complete", "batch.failed", "batch.partial", "ping" ] } }, { "in": "query", "name": "status", "required": false, "schema": { "type": "string", "enum": [ "pending", "success", "failed" ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListOrganizationsWebhooksDeliveriesResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundWebhookNotFound" } } }, "description": "not_found, webhook_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/organizations/{organization_id}/webhooks/{id}/rotate-secret": { "post": { "summary": "Rotate webhook secret", "tags": [ "Webhooks" ], "operationId": "webhook.rotateSecret", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationsWebhookResponse201" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundWebhookNotFound" } } }, "description": "not_found, webhook_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/organizations/{organization_id}/webhooks/{id}/test": { "post": { "summary": "Send test webhook", "tags": [ "Webhooks" ], "operationId": "webhook.test", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "organization_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationsWebhooksTestResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundWebhookNotFound" } } }, "description": "not_found, webhook_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/batches": { "get": { "summary": "List batches", "tags": [ "Batches" ], "operationId": "batch.list", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Opaque cursor for forward pagination. Pass the nextCursor from the previous response with the same order. Takes precedence over page when both are sent.", "examples": [ "eyJpIjoiMDFIIiwicyI6IiIsInYiOltdfQ" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "description": "1-based page number for offset pagination. Ignored when cursor is present.", "examples": [ 1, 2 ], "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, { "in": "query", "name": "order", "required": false, "schema": { "description": "Sort keys, comma-separated, each `field[.asc|.desc][.nullsfirst|.nullslast]`; at most 3. Sortable: created_at, status, total_rows. Default: created_at.desc. Nulls sort last ascending and first descending unless stated.", "examples": [ "created_at.desc", "status.asc,created_at.desc" ], "pattern": "^(?:created_at|status|total_rows)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?(?:,(?:created_at|status|total_rows)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?){0,2}$", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "Maximum number of items per page. Defaults to 20, capped by the endpoint's maxLimit.", "examples": [ 20, 50 ], "type": "integer", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "status", "required": false, "schema": { "type": "string", "enum": [ "uploading", "processing", "merging", "complete", "partial", "failed" ] } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProjectsBatchesResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/batches/{batch_id}": { "get": { "summary": "Get batch", "tags": [ "Batches" ], "operationId": "batch.get", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProjectsBatcheResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404BatchNotFoundNotFound" } } }, "description": "batch_not_found, not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/batches/{batch_id}/download/csv": { "get": { "summary": "Download batch CSV", "tags": [ "Batches" ], "operationId": "batch.download.csv", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404BatchNotFoundNotFound" } } }, "description": "batch_not_found, not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/batches/{batch_id}/download/json": { "get": { "summary": "Download batch JSON", "tags": [ "Batches" ], "operationId": "batch.download.json", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404BatchNotFoundNotFound" } } }, "description": "batch_not_found, not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/batches/{batch_id}/download/xlsx": { "get": { "summary": "Download batch XLSX", "tags": [ "Batches" ], "operationId": "batch.download.xlsx", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "batch_id", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404BatchNotFoundNotFound" } } }, "description": "batch_not_found, not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/exports/{export_id}": { "get": { "summary": "Get export status", "tags": [ "Export" ], "operationId": "export.get", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "export_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProjectsExportResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProjectsExportResponse404" } } }, "description": "export_not_found, not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/extract": { "post": { "summary": "Extract data from text or file (JSON response)", "tags": [ "Extract" ], "operationId": "extract.once", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateProjectsExtractRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateProjectsExtractRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsExtractResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/extract-stream": { "post": { "summary": "Extract data from text or file (SSE stream)", "tags": [ "Extract" ], "operationId": "extract.stream", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateProjectsExtractRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateProjectsExtractRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/CreateProjectsExtractStreamResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/suggest-schema": { "post": { "summary": "Suggest schema from text or file (multipart)", "tags": [ "Schema" ], "operationId": "suggest.schema", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateProjectsSuggestSchemaRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateProjectsSuggestSchemaRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsSuggestSchemaResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/table-templates": { "get": { "summary": "Browse table templates", "tags": [ "Table Templates" ], "operationId": "tableTemplate.projectList", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Opaque cursor for forward pagination. Pass the nextCursor from the previous response with the same order. Takes precedence over page when both are sent.", "examples": [ "eyJpIjoiMDFIIiwicyI6IiIsInYiOltdfQ" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "description": "1-based page number for offset pagination. Ignored when cursor is present.", "examples": [ 1, 2 ], "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, { "in": "query", "name": "order", "required": false, "schema": { "description": "Sort keys, comma-separated, each `field[.asc|.desc][.nullsfirst|.nullslast]`; at most 3. Sortable: category, created_at, name, updated_at, usage_count. Default: category.desc. Nulls sort last ascending and first descending unless stated.", "examples": [ "category.desc", "created_at.asc,category.desc" ], "pattern": "^(?:category|created_at|name|updated_at|usage_count)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?(?:,(?:category|created_at|name|updated_at|usage_count)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?){0,2}$", "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "description": "Filter expression `field.op.value`; `,` joins conditions with AND; group with `or(...)` and `and(...)`. Fields: category (enum: eq, ne, neq, in, nin, is); created_at (number: eq, ne, neq, gt, gte, lt, lte, in, nin, is); id (string: eq, ne, neq, like, ilike, in, nin, is); name (string: eq, ne, neq, like, ilike, in, nin, is). `like` is case-sensitive and `ilike` ignores ASCII case; `*` is the wildcard. `in`/`nin` take `(a,b)`; `is` takes `null` or `notnull`. At most 20 conditions, 3 nested groups, 100 in/nin values.", "examples": [ "category.is.notnull", "id.ilike.*acme*", "or(category.is.notnull,created_at.gte.10)" ], "type": "string" } }, { "in": "query", "name": "q", "required": false, "schema": { "description": "Free-text search over: name, description, creator_display_name. Whitespace-separated terms must all match.", "examples": [ "acme", "acme corp" ], "type": "string", "maxLength": 200 } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "Maximum number of items per page. Defaults to 20, capped by the endpoint's maxLimit.", "examples": [ 20, 50 ], "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProjectsTableTemplatesResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/table-templates/{template_id}": { "get": { "summary": "Preview table template", "tags": [ "Table Templates" ], "operationId": "tableTemplate.projectGet", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "template_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProjectsTableTemplateResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/table-templates/{template_id}/use": { "post": { "summary": "Create table from template", "tags": [ "Table Templates" ], "operationId": "tableTemplate.use", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "template_id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseResponse201" } } }, "description": "created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err409TableProjectIdDuplicate" } } }, "description": "table_project_id_duplicate" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables": { "get": { "summary": "List tables", "tags": [ "Tables" ], "operationId": "table.list", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Opaque cursor for forward pagination. Pass the nextCursor from the previous response with the same order. Takes precedence over page when both are sent.", "examples": [ "eyJpIjoiMDFIIiwicyI6IiIsInYiOltdfQ" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "description": "1-based page number for offset pagination. Ignored when cursor is present.", "examples": [ 1, 2 ], "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, { "in": "query", "name": "order", "required": false, "schema": { "description": "Sort keys, comma-separated, each `field[.asc|.desc][.nullsfirst|.nullslast]`; at most 3. Sortable: created_at, name, row_count, last_used_at, updated_at. Default: created_at.desc. Nulls sort last ascending and first descending unless stated.", "examples": [ "created_at.desc", "name.asc,created_at.desc" ], "pattern": "^(?:created_at|name|row_count|last_used_at|updated_at)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?(?:,(?:created_at|name|row_count|last_used_at|updated_at)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?){0,2}$", "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "description": "Filter expression `field.op.value`; `,` joins conditions with AND; group with `or(...)` and `and(...)`. Fields: created_at (number: eq, ne, neq, gt, gte, lt, lte, in, nin, is); id (string: eq, ne, neq, like, ilike, in, nin, is); name (string: eq, ne, neq, like, ilike, in, nin, is); row_count (number: eq, ne, neq, gt, gte, lt, lte, in, nin, is); slug (string: eq, ne, neq, like, ilike, in, nin, is). `like` is case-sensitive and `ilike` ignores ASCII case; `*` is the wildcard. `in`/`nin` take `(a,b)`; `is` takes `null` or `notnull`. At most 20 conditions, 3 nested groups, 100 in/nin values.", "examples": [ "created_at.gte.10", "id.ilike.*acme*", "or(created_at.gte.10,id.ilike.*acme*)" ], "type": "string" } }, { "in": "query", "name": "q", "required": false, "schema": { "description": "Free-text search over: name. Whitespace-separated terms must all match.", "examples": [ "acme", "acme corp" ], "type": "string", "maxLength": 200 } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "Maximum number of items per page. Defaults to 20, capped by the endpoint's maxLimit.", "examples": [ 20, 50 ], "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProjectsTablesResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "post": { "summary": "Create table", "tags": [ "Tables" ], "operationId": "table.create", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseResponse201" } } }, "description": "created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}": { "get": { "summary": "Get table", "tags": [ "Tables" ], "operationId": "table.get", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseResponse201" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "patch": { "summary": "Update table", "tags": [ "Tables" ], "operationId": "table.update", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectsTableRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseResponse201" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err409TableProjectIdDuplicate" } } }, "description": "table_project_id_duplicate" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "delete": { "summary": "Delete table (soft, 72h grace)", "tags": [ "Tables" ], "operationId": "table.delete", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationsWebhookResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/columns": { "post": { "summary": "Add column", "tags": [ "Columns" ], "operationId": "column.add", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTablesColumnRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseResponse201" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err409OptimisticLockConflict" } } }, "description": "optimistic_lock_conflict" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/columns/order": { "put": { "summary": "Reorder columns", "tags": [ "Columns" ], "operationId": "column.reorder", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceProjectsTablesColumnRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseResponse201" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404ColumnNotFoundNotFoundTableNotFound" } } }, "description": "column_not_found, not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err409OptimisticLockConflict" } } }, "description": "optimistic_lock_conflict" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/columns/{col_id}": { "patch": { "summary": "Update column", "tags": [ "Columns" ], "operationId": "column.update", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProjectsTablesColumnRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "col_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseResponse201" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404ColumnNotFoundNotFoundTableNotFound" } } }, "description": "column_not_found, not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err409OptimisticLockConflict" } } }, "description": "optimistic_lock_conflict" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "delete": { "summary": "Remove column", "tags": [ "Columns" ], "operationId": "column.remove", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "col_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseResponse201" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404ColumnNotFoundNotFoundTableNotFound" } } }, "description": "column_not_found, not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err409OptimisticLockConflict" } } }, "description": "optimistic_lock_conflict" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/columns/{col_id}/distinct": { "get": { "summary": "Get distinct column values", "tags": [ "Columns" ], "operationId": "column.distinct", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "col_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500 } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProjectsTablesColumnsDistinctResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404ColumnNotFoundNotFoundTableNotFound" } } }, "description": "column_not_found, not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/duplicate": { "post": { "summary": "Duplicate table structure", "tags": [ "Tables" ], "operationId": "table.duplicate", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTablesDuplicateRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseResponse201" } } }, "description": "created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err409TableProjectIdDuplicate" } } }, "description": "table_project_id_duplicate" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/export": { "get": { "summary": "Export table rows", "tags": [ "Export" ], "operationId": "table.export", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "format", "required": true, "schema": { "type": "string", "enum": [ "csv", "json", "xlsx" ] } }, { "in": "query", "name": "order", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "schema", "required": false, "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "in": "query", "name": "search", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "since", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProjectsTablesExportResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/extract": { "post": { "summary": "Extract into table (JSON response)", "tags": [ "Extract" ], "operationId": "extract.table.once", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateProjectsSuggestSchemaRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateProjectsSuggestSchemaRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsExtractResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/extract-stream": { "post": { "summary": "Extract into table (SSE stream)", "tags": [ "Extract" ], "operationId": "extract.table.stream", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CreateProjectsSuggestSchemaRequest" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateProjectsSuggestSchemaRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "text/event-stream": { "schema": { "$ref": "#/components/schemas/CreateProjectsExtractStreamResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/restore": { "post": { "summary": "Restore deleted table", "tags": [ "Tables" ], "operationId": "table.restore", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTablesRestoreRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTableTemplatesUseResponse201" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err409TableProjectIdDuplicate" } } }, "description": "table_project_id_duplicate" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/rows": { "get": { "summary": "List rows", "tags": [ "Rows" ], "operationId": "row.list", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 } }, { "in": "query", "name": "order", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, { "in": "query", "name": "q", "required": false, "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProjectsTablesRowsResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "post": { "summary": "Create row", "tags": [ "Rows" ], "operationId": "row.create", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTablesRowRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTablesRowRequest" } } }, "description": "created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/rows/aggregate": { "get": { "summary": "Aggregate column values", "tags": [ "Rows" ], "operationId": "row.aggregate", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "aggs", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProjectsTablesRowsResponse200_21d74b" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/rows/bulk": { "post": { "summary": "Bulk create/update/delete rows", "tags": [ "Rows" ], "operationId": "row.bulk", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTablesRowRequest_dbbb57" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTablesRowResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableNotFound" } } }, "description": "not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/rows/{row_id}": { "get": { "summary": "Get row", "tags": [ "Rows" ], "operationId": "row.get", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "row_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTablesRowRequest" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundRowNotFoundTableNotFound" } } }, "description": "not_found, row_not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "patch": { "summary": "Update row", "tags": [ "Rows" ], "operationId": "row.update", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTablesRowRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "row_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectsTablesRowRequest" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundRowNotFoundTableNotFound" } } }, "description": "not_found, row_not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "delete": { "summary": "Delete row", "tags": [ "Rows" ], "operationId": "row.delete", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "row_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationsWebhookResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundRowNotFoundTableNotFound" } } }, "description": "not_found, row_not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/projects/{project_id}/tables/{table_id}/rows/{row_id}/source": { "get": { "summary": "The source file behind a row: download it, or open a PDF or image inline", "tags": [ "Rows" ], "operationId": "row.source", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "project_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "table_id", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "row_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "disposition", "required": false, "schema": { "default": "attachment", "type": "string", "enum": [ "attachment", "inline" ] } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ListProjectsTablesRowsSourceResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProjectsTablesRowsSourceResponse404" } } }, "description": "not_found, row_not_found, row_source_not_found, table_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/table-templates": { "post": { "summary": "Create table template", "tags": [ "Table Templates" ], "operationId": "tableTemplate.create", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTableTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProjectsTableTemplateResponse200" } } }, "description": "created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/table-templates/mine": { "get": { "summary": "List my table templates", "tags": [ "Table Templates" ], "operationId": "tableTemplate.listMine", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Opaque cursor for forward pagination. Pass the nextCursor from the previous response with the same order. Takes precedence over page when both are sent.", "examples": [ "eyJpIjoiMDFIIiwicyI6IiIsInYiOltdfQ" ], "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "description": "1-based page number for offset pagination. Ignored when cursor is present.", "examples": [ 1, 2 ], "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, { "in": "query", "name": "order", "required": false, "schema": { "description": "Sort keys, comma-separated, each `field[.asc|.desc][.nullsfirst|.nullslast]`; at most 3. Sortable: category, created_at, name, updated_at, usage_count. Default: category.desc. Nulls sort last ascending and first descending unless stated.", "examples": [ "category.desc", "created_at.asc,category.desc" ], "pattern": "^(?:category|created_at|name|updated_at|usage_count)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?(?:,(?:category|created_at|name|updated_at|usage_count)(?:\\.(?:asc|desc))?(?:\\.(?:nullsfirst|nullslast))?){0,2}$", "type": "string" } }, { "in": "query", "name": "filter", "required": false, "schema": { "description": "Filter expression `field.op.value`; `,` joins conditions with AND; group with `or(...)` and `and(...)`. Fields: category (enum: eq, ne, neq, in, nin, is); created_at (number: eq, ne, neq, gt, gte, lt, lte, in, nin, is); id (string: eq, ne, neq, like, ilike, in, nin, is); name (string: eq, ne, neq, like, ilike, in, nin, is). `like` is case-sensitive and `ilike` ignores ASCII case; `*` is the wildcard. `in`/`nin` take `(a,b)`; `is` takes `null` or `notnull`. At most 20 conditions, 3 nested groups, 100 in/nin values.", "examples": [ "category.is.notnull", "id.ilike.*acme*", "or(category.is.notnull,created_at.gte.10)" ], "type": "string" } }, { "in": "query", "name": "q", "required": false, "schema": { "description": "Free-text search over: name, description, creator_display_name. Whitespace-separated terms must all match.", "examples": [ "acme", "acme corp" ], "type": "string", "maxLength": 200 } }, { "in": "query", "name": "select", "required": false, "schema": { "description": "PostgREST-style sparse fieldset. Scalars comma-separated; relations embedded as name(fields); wildcard * selects all scalars. Docs: https://docs.postgrest.org/en/stable/references/api/resource_embedding.html", "examples": [ "id,name,email", "id,author(name)", "id,author(name,posts(title))", "*" ], "type": "string", "maxLength": 500 } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "description": "Maximum number of items per page. Defaults to 20, capped by the endpoint's maxLimit.", "examples": [ 20, 50 ], "type": "integer", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProjectsTableTemplatesResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFound" } } }, "description": "not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } }, "/v1/table-templates/{template_id}": { "patch": { "summary": "Update table template", "tags": [ "Table Templates" ], "operationId": "tableTemplate.update", "security": [ { "apiKey": [] } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTableTemplateRequest" } } }, "required": true }, "parameters": [ { "in": "path", "name": "template_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetProjectsTableTemplateResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspendedTableTemplateForbidden" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended, table_template_forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableTemplateNotFound" } } }, "description": "not_found, table_template_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } }, "delete": { "summary": "Delete table template", "tags": [ "Table Templates" ], "operationId": "tableTemplate.delete", "security": [ { "apiKey": [] } ], "parameters": [ { "in": "path", "name": "template_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteOrganizationsWebhookResponse200" } } }, "description": "ok" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err400CaptchaFailedCaptchaRequiredInvalidInput" } } }, "description": "captcha_failed, captcha_required, invalid_input" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err401ImpersonationEndedUnauthorized" } } }, "description": "impersonation_ended, unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err402ApiRequestLimitExceededFeatureNotAvailable" } } }, "description": "api_request_limit_exceeded, feature_not_available" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspendedTableTemplateForbidden" } } }, "description": "email_not_verified, forbidden, impersonation_forbidden, org_suspended, table_template_forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err404NotFoundTableTemplateNotFound" } } }, "description": "not_found, table_template_not_found" }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err408RequestTimeout" } } }, "description": "request_timeout" }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err413ContentTooLarge" } } }, "description": "content_too_large" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err415UnsupportedMediaType" } } }, "description": "unsupported_media_type" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err422UnprocessableEntity" } } }, "description": "unprocessable_entity" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err429TooManyRequests" } } }, "description": "too_many_requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err500CaptchaUnavailableInternalServerError" } } }, "description": "captcha_unavailable, internal_server_error" }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err502BadGateway" } } }, "description": "bad_gateway" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err503ServiceUnavailable" } } }, "description": "service_unavailable" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Err504GatewayTimeout" } } }, "description": "gateway_timeout" } } } } }, "servers": [ { "url": "/api" } ], "components": { "securitySchemes": { "apiKey": { "description": "API key authentication. Format: ApiKey {your_api_key}", "in": "header", "name": "Authorization", "type": "apiKey" }, "jwt": { "bearerFormat": "JWT", "scheme": "bearer", "type": "http" } }, "schemas": { "CreateOrganizationsWebhookRequest": { "type": "object", "properties": { "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "batch.complete", "batch.failed", "batch.partial", "ping" ] } }, "name": { "type": "string", "maxLength": 64 }, "url": { "type": "string", "maxLength": 2048, "format": "uri", "pattern": "^https:\\/\\/.*" } }, "required": [ "events", "url" ] }, "CreateOrganizationsWebhookResponse201": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "whook_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "name": { "anyOf": [ { "type": "string", "maxLength": 64, "examples": [ "string" ] }, { "type": "null" } ] }, "organization_id": { "type": "string", "minLength": 1, "maxLength": 48 }, "url": { "type": "string", "maxLength": 2048, "format": "uri", "examples": [ "https://example.com" ] }, "secret_rotated_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] }, "active": { "type": "boolean", "examples": [ true ] }, "failure_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "last_triggered_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "batch.complete", "batch.failed", "batch.partial", "ping" ] } }, "secret": { "type": "string" } }, "required": [ "created_at", "updated_at", "id", "name", "organization_id", "url", "secret_rotated_at", "active", "failure_count", "last_triggered_at", "events", "secret" ], "additionalProperties": false }, "Err400CaptchaFailedCaptchaRequiredInvalidInput": { "type": "object", "properties": { "error_key": { "enum": [ "captcha_failed", "captcha_required", "invalid_input" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 400 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err401ImpersonationEndedUnauthorized": { "type": "object", "properties": { "error_key": { "enum": [ "impersonation_ended", "unauthorized" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 401 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err402ApiRequestLimitExceededFeatureNotAvailable": { "type": "object", "properties": { "error_key": { "enum": [ "api_request_limit_exceeded", "feature_not_available" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 402 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspended": { "type": "object", "properties": { "error_key": { "enum": [ "email_not_verified", "forbidden", "impersonation_forbidden", "org_suspended" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 403 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err404NotFound": { "type": "object", "properties": { "error_key": { "enum": [ "not_found" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 404 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err408RequestTimeout": { "type": "object", "properties": { "error_key": { "enum": [ "request_timeout" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 408 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err413ContentTooLarge": { "type": "object", "properties": { "error_key": { "enum": [ "content_too_large" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 413 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err415UnsupportedMediaType": { "type": "object", "properties": { "error_key": { "enum": [ "unsupported_media_type" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 415 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err422UnprocessableEntity": { "type": "object", "properties": { "error_key": { "enum": [ "unprocessable_entity" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 422 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err429TooManyRequests": { "type": "object", "properties": { "error_key": { "enum": [ "too_many_requests" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 429 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err500CaptchaUnavailableInternalServerError": { "type": "object", "properties": { "error_key": { "enum": [ "captcha_unavailable", "internal_server_error" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 500 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err502BadGateway": { "type": "object", "properties": { "error_key": { "enum": [ "bad_gateway" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 502 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err503ServiceUnavailable": { "type": "object", "properties": { "error_key": { "enum": [ "service_unavailable" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 503 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err504GatewayTimeout": { "type": "object", "properties": { "error_key": { "enum": [ "gateway_timeout" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 504 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "ListOrganizationsWebhooksResponse200": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" }, "limit": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "nextCursor": { "type": [ "string", "null" ] }, "page": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, { "type": "null" } ] }, "webhooks": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "whook_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "name": { "anyOf": [ { "type": "string", "maxLength": 64, "examples": [ "string" ] }, { "type": "null" } ] }, "organization_id": { "type": "string", "minLength": 1, "maxLength": 48 }, "url": { "type": "string", "maxLength": 2048, "format": "uri", "examples": [ "https://example.com" ] }, "secret_rotated_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] }, "active": { "type": "boolean", "examples": [ true ] }, "failure_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "last_triggered_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "batch.complete", "batch.failed", "batch.partial", "ping" ] } } }, "required": [ "created_at", "updated_at", "id", "name", "organization_id", "url", "secret_rotated_at", "active", "failure_count", "last_triggered_at", "events" ], "additionalProperties": false } } }, "required": [ "count", "hasMore", "limit", "nextCursor", "page", "webhooks" ], "additionalProperties": false }, "GetOrganizationsWebhookResponse200": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "whook_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "name": { "anyOf": [ { "type": "string", "maxLength": 64, "examples": [ "string" ] }, { "type": "null" } ] }, "organization_id": { "type": "string", "minLength": 1, "maxLength": 48 }, "url": { "type": "string", "maxLength": 2048, "format": "uri", "examples": [ "https://example.com" ] }, "secret_rotated_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] }, "active": { "type": "boolean", "examples": [ true ] }, "failure_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "last_triggered_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "batch.complete", "batch.failed", "batch.partial", "ping" ] } } }, "required": [ "created_at", "updated_at", "id", "name", "organization_id", "url", "secret_rotated_at", "active", "failure_count", "last_triggered_at", "events" ], "additionalProperties": false }, "Err404NotFoundWebhookNotFound": { "type": "object", "properties": { "error_key": { "enum": [ "not_found", "webhook_not_found" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 404 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "UpdateOrganizationsWebhookRequest": { "type": "object", "properties": { "active": { "type": "boolean" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "batch.complete", "batch.failed", "batch.partial", "ping" ] } }, "name": { "type": "string", "maxLength": 64 }, "url": { "type": "string", "maxLength": 2048, "format": "uri", "pattern": "^https:\\/\\/.*" } } }, "DeleteOrganizationsWebhookResponse200": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": false }, "ListOrganizationsWebhooksDeliveriesResponse200": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" }, "limit": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "nextCursor": { "type": [ "string", "null" ] }, "page": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, { "type": "null" } ] }, "deliveries": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "whdlv_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "webhook_id": { "type": "string", "minLength": 1, "maxLength": 48 }, "event": { "type": "string", "enum": [ "batch.complete", "batch.failed", "batch.partial", "ping" ], "examples": [ "string" ] }, "payload_json": { "type": "string", "maxLength": 65536, "examples": [ "string" ] }, "status": { "type": "string", "enum": [ "pending", "success", "failed" ], "examples": [ "string" ] }, "http_status": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, { "type": "null" } ] }, "response_body": { "anyOf": [ { "type": "string", "maxLength": 4096, "examples": [ "string" ] }, { "type": "null" } ] }, "attempt": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "examples": [ 42 ] }, "next_retry_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] }, "delivered_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] } }, "required": [ "created_at", "id", "webhook_id", "event", "payload_json", "status", "http_status", "response_body", "attempt", "next_retry_at", "delivered_at" ], "additionalProperties": false, "x-comb": { "generated": [ "id", "created_at" ], "identity": "id", "immutable": [ "id", "webhook_id", "created_at" ], "kind": "entity", "name": "webhook_delivery", "softDelete": null, "states": null, "tenantColumn": null, "uniqueIndexes": [], "v": 1 } } } }, "required": [ "count", "hasMore", "limit", "nextCursor", "page", "deliveries" ], "additionalProperties": false }, "CreateOrganizationsWebhooksTestResponse200": { "type": "object", "properties": { "http_status": { "type": [ "number", "null" ] }, "response_body": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "error", "success", "timeout" ] } }, "required": [ "http_status", "response_body", "status" ], "additionalProperties": false }, "ListProjectsBatchesResponse200": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" }, "limit": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "nextCursor": { "type": [ "string", "null" ] }, "page": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, { "type": "null" } ] }, "batches": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "batch_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "project_id": { "type": "string", "minLength": 1, "maxLength": 48 }, "table_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 48 }, { "type": "null" } ] }, "actor_type": { "type": "string", "enum": [ "user", "api_key" ], "examples": [ "string" ] }, "actor_id": { "type": "string", "maxLength": 36, "examples": [ "string" ] }, "schema_json": { "type": "object", "properties": { "columns": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } }, "required": [ "name", "type" ], "additionalProperties": false } }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "strictness": { "default": "strict", "type": "string", "enum": [ "strict", "balanced", "flexible" ] } }, "required": [ "columns", "strictness" ], "additionalProperties": false }, "insert_mode": { "anyOf": [ { "type": "string", "enum": [ "append", "dedup", "merge", "replace" ], "examples": [ "string" ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "uploading", "processing", "merging", "complete", "partial", "failed" ], "examples": [ "string" ] }, "file_count": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "examples": [ 42 ] }, "files_done": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "current_file": { "anyOf": [ { "type": "string", "maxLength": 255, "examples": [ "string" ] }, { "type": "null" } ] }, "csv_key": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "json_key": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "xlsx_key": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "total_rows": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "examples": [ 0.5 ] }, { "type": "null" } ] }, "duration_ms": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string", "maxLength": 2048, "examples": [ "string" ] }, { "type": "null" } ] } }, "required": [ "created_at", "updated_at", "id", "project_id", "table_id", "actor_type", "actor_id", "schema_json", "insert_mode", "status", "file_count", "files_done", "current_file", "csv_key", "json_key", "xlsx_key", "total_rows", "confidence", "duration_ms", "error" ], "additionalProperties": false, "x-comb": { "generated": [ "id", "created_at", "updated_at" ], "identity": "id", "immutable": [ "id", "project_id", "table_id", "created_at", "updated_at" ], "kind": "entity", "name": "batch", "softDelete": null, "states": null, "tenantColumn": null, "uniqueIndexes": [], "v": 1 } } } }, "required": [ "count", "hasMore", "limit", "nextCursor", "page", "batches" ], "additionalProperties": false }, "GetProjectsBatcheResponse200": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "batch_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "project_id": { "type": "string", "minLength": 1, "maxLength": 48 }, "table_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 48 }, { "type": "null" } ] }, "actor_type": { "type": "string", "enum": [ "user", "api_key" ], "examples": [ "string" ] }, "actor_id": { "type": "string", "maxLength": 36, "examples": [ "string" ] }, "schema_json": { "type": "object", "properties": { "columns": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } }, "required": [ "name", "type" ], "additionalProperties": false } }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "strictness": { "default": "strict", "type": "string", "enum": [ "strict", "balanced", "flexible" ] } }, "required": [ "columns", "strictness" ], "additionalProperties": false }, "insert_mode": { "anyOf": [ { "type": "string", "enum": [ "append", "dedup", "merge", "replace" ], "examples": [ "string" ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "uploading", "processing", "merging", "complete", "partial", "failed" ], "examples": [ "string" ] }, "file_count": { "type": "integer", "minimum": 1, "maximum": 9007199254740991, "examples": [ 42 ] }, "files_done": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "current_file": { "anyOf": [ { "type": "string", "maxLength": 255, "examples": [ "string" ] }, { "type": "null" } ] }, "csv_key": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "json_key": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "xlsx_key": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "total_rows": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "examples": [ 0.5 ] }, { "type": "null" } ] }, "duration_ms": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string", "maxLength": 2048, "examples": [ "string" ] }, { "type": "null" } ] }, "extractions": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "extr_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "batch_id": { "type": "string", "minLength": 1, "maxLength": 48 }, "table_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 48 }, { "type": "null" } ] }, "file_key": { "type": "string", "maxLength": 512, "examples": [ "string" ] }, "file_name": { "type": "string", "maxLength": 255, "examples": [ "string" ] }, "file_type": { "anyOf": [ { "type": "string", "enum": [ "text_pdf", "scanned", "image", "text", "document", "unknown" ], "examples": [ "string" ] }, { "type": "null" } ] }, "file_checksum": { "anyOf": [ { "type": "string", "maxLength": 64, "examples": [ "string" ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "processing", "complete", "failed" ], "examples": [ "string" ] }, "rows_key": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "row_count": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, { "type": "null" } ] }, "confidence": { "anyOf": [ { "type": "number", "examples": [ 0.5 ] }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string", "maxLength": 2048, "examples": [ "string" ] }, { "type": "null" } ] } }, "required": [ "created_at", "id", "batch_id", "table_id", "file_key", "file_name", "file_type", "file_checksum", "status", "rows_key", "row_count", "confidence", "error" ], "additionalProperties": false, "x-comb": { "generated": [ "id", "created_at" ], "identity": "id", "immutable": [ "id", "batch_id", "table_id", "created_at" ], "kind": "entity", "name": "extraction", "softDelete": null, "states": null, "tenantColumn": null, "uniqueIndexes": [], "v": 1 } } } }, "required": [ "created_at", "updated_at", "id", "project_id", "table_id", "actor_type", "actor_id", "schema_json", "insert_mode", "status", "file_count", "files_done", "current_file", "csv_key", "json_key", "xlsx_key", "total_rows", "confidence", "duration_ms", "error" ], "additionalProperties": false }, "Err404BatchNotFoundNotFound": { "type": "object", "properties": { "error_key": { "enum": [ "batch_not_found", "not_found" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 404 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "GetProjectsExportResponse200": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "exprt_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "project_id": { "type": "string", "minLength": 1, "maxLength": 48 }, "table_id": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 48 }, { "type": "null" } ] }, "actor_id": { "type": "string", "maxLength": 36, "examples": [ "string" ] }, "checksum": { "type": "string", "maxLength": 64, "examples": [ "string" ] }, "status": { "type": "string", "enum": [ "processing", "complete", "failed" ], "examples": [ "string" ] }, "filter_json": { "anyOf": [ { "type": "string", "maxLength": 4096, "examples": [ "string" ] }, { "type": "null" } ] }, "row_count": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, { "type": "null" } ] }, "json_key": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "csv_key": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "xlsx_key": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string", "maxLength": 2048, "examples": [ "string" ] }, { "type": "null" } ] }, "expires_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] } }, "required": [ "created_at", "updated_at", "id", "project_id", "table_id", "actor_id", "checksum", "status", "filter_json", "row_count", "json_key", "csv_key", "xlsx_key", "error", "expires_at" ], "additionalProperties": false, "x-comb": { "generated": [ "id", "created_at", "updated_at" ], "identity": "id", "immutable": [ "id", "project_id", "table_id", "created_at", "updated_at" ], "kind": "entity", "name": "data_export", "softDelete": null, "states": null, "tenantColumn": null, "uniqueIndexes": [ { "columns": [ "checksum" ], "name": "idx_data_export_checksum" } ], "v": 1 } }, "GetProjectsExportResponse404": { "type": "object", "properties": { "error_key": { "enum": [ "export_not_found", "not_found" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 404 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "CreateProjectsExtractRequest": { "type": "object", "properties": { "columns": { "type": "string" }, "file": { "type": "string", "format": "binary", "contentEncoding": "binary" }, "instruction": { "type": "string", "maxLength": 1000000 }, "schema": { "type": "string" }, "strictness": { "type": "string", "enum": [ "strict", "balanced", "flexible" ] }, "text": { "type": "string", "maxLength": 1000000 } } }, "CreateProjectsExtractResponse200": { "type": "object", "properties": { "batch_id": { "type": "string" }, "confidence": { "type": [ "number", "null" ] }, "credits": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "duration_ms": { "type": [ "number", "null" ] }, "fail_count": { "type": "number" }, "file_type": { "anyOf": [ { "type": "string", "enum": [ "text_pdf", "scanned", "image", "text", "document", "unknown" ] }, { "type": "null" } ] }, "files": { "type": "array", "items": { "type": "object", "properties": { "confidence": { "type": [ "number", "null" ] }, "error": { "anyOf": [ {}, { "type": "null" } ] }, "file_name": { "anyOf": [ {}, { "type": "null" } ] }, "rows": { "type": [ "number", "null" ] }, "status": { "type": "string" } }, "additionalProperties": false } }, "result": { "$ref": "#/components/schemas/CreateProjectsExtractResponse200Result" }, "status": { "type": "string" }, "success_count": { "type": "number" }, "table_id": { "type": "string" }, "total_rows": { "type": "number" } }, "required": [ "confidence", "credits", "duration_ms", "fail_count", "files", "status", "success_count", "table_id", "total_rows" ], "additionalProperties": false }, "CreateProjectsExtractStreamResponse200": { "type": "string" }, "CreateProjectsSuggestSchemaRequest": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "contentEncoding": "binary" }, "text": { "type": "string", "maxLength": 1000000 } } }, "CreateProjectsSuggestSchemaResponse200": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "additionalProperties": false } }, "confidence": { "type": "number" }, "instruction": { "type": "string" } }, "required": [ "columns", "confidence" ], "additionalProperties": false }, "ListProjectsTableTemplatesResponse200": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" }, "limit": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "nextCursor": { "type": [ "string", "null" ] }, "page": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, { "type": "null" } ] }, "templates": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "ttmpl_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "category": { "type": "string", "maxLength": 64, "examples": [ "string" ] }, "columns_json": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "currency_code": { "type": "string", "minLength": 3, "maxLength": 3 }, "default": {}, "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "id": { "type": "string", "minLength": 1, "maxLength": 36 }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "options": { "maxItems": 500, "type": "array", "items": { "type": "string", "maxLength": 256 } }, "required": { "default": false, "type": "boolean" }, "searchable": { "type": "boolean" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } }, "required": [ "id", "name", "required", "type" ], "additionalProperties": false } }, "creator_display_name": { "anyOf": [ { "type": "string", "maxLength": 101, "examples": [ "string" ] }, { "type": "null" } ] }, "creator_user_id": { "anyOf": [ { "type": "string", "maxLength": 48, "examples": [ "string" ] }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "insert_mode": { "type": "string", "enum": [ "append", "dedup", "merge", "replace" ], "examples": [ "string" ] }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "merge_columns_json": { "anyOf": [ { "minItems": 1, "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string", "maxLength": 128, "examples": [ "string" ] }, "strictness": { "type": "string", "enum": [ "strict", "balanced", "flexible" ], "examples": [ "string" ] }, "usage_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] } }, "required": [ "created_at", "updated_at", "id", "category", "columns_json", "creator_display_name", "creator_user_id", "description", "insert_mode", "instruction", "merge_columns_json", "name", "strictness", "usage_count" ], "additionalProperties": false, "x-comb": { "generated": [ "id", "updated_at", "created_at" ], "identity": "id", "immutable": [ "id", "_search", "updated_at", "created_at" ], "kind": "entity", "name": "table_template", "softDelete": null, "states": null, "tenantColumn": null, "uniqueIndexes": [], "v": 1 } } } }, "required": [ "count", "hasMore", "limit", "nextCursor", "page", "templates" ], "additionalProperties": false }, "GetProjectsTableTemplateResponse200": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "ttmpl_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "category": { "type": "string", "maxLength": 64, "examples": [ "string" ] }, "columns_json": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "currency_code": { "type": "string", "minLength": 3, "maxLength": 3 }, "default": {}, "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "id": { "type": "string", "minLength": 1, "maxLength": 36 }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "options": { "maxItems": 500, "type": "array", "items": { "type": "string", "maxLength": 256 } }, "required": { "default": false, "type": "boolean" }, "searchable": { "type": "boolean" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } }, "required": [ "id", "name", "required", "type" ], "additionalProperties": false } }, "creator_display_name": { "anyOf": [ { "type": "string", "maxLength": 101, "examples": [ "string" ] }, { "type": "null" } ] }, "creator_user_id": { "anyOf": [ { "type": "string", "maxLength": 48, "examples": [ "string" ] }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "insert_mode": { "type": "string", "enum": [ "append", "dedup", "merge", "replace" ], "examples": [ "string" ] }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "merge_columns_json": { "anyOf": [ { "minItems": 1, "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string", "maxLength": 128, "examples": [ "string" ] }, "strictness": { "type": "string", "enum": [ "strict", "balanced", "flexible" ], "examples": [ "string" ] }, "usage_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] } }, "required": [ "created_at", "updated_at", "id", "category", "columns_json", "creator_display_name", "creator_user_id", "description", "insert_mode", "instruction", "merge_columns_json", "name", "strictness", "usage_count" ], "additionalProperties": false, "x-comb": { "generated": [ "id", "updated_at", "created_at" ], "identity": "id", "immutable": [ "id", "_search", "updated_at", "created_at" ], "kind": "entity", "name": "table_template", "softDelete": null, "states": null, "tenantColumn": null, "uniqueIndexes": [], "v": 1 } }, "Err404NotFoundTableNotFound": { "type": "object", "properties": { "error_key": { "enum": [ "not_found", "table_not_found" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 404 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "CreateProjectsTableTemplatesUseRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128, "examples": [ "string" ] }, "slug": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "string" ] } }, "required": [ "name" ] }, "CreateProjectsTableTemplatesUseResponse201": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "deleted_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "tbl_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "project_id": { "type": "string", "minLength": 1, "maxLength": 48 }, "name": { "type": "string", "minLength": 1, "maxLength": 128, "examples": [ "string" ] }, "slug": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "string" ] }, "columns_json": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "currency_code": { "type": "string", "minLength": 3, "maxLength": 3 }, "default": {}, "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "id": { "type": "string", "minLength": 1, "maxLength": 36 }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "options": { "maxItems": 500, "type": "array", "items": { "type": "string", "maxLength": 256 } }, "required": { "default": false, "type": "boolean" }, "searchable": { "type": "boolean" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } }, "required": [ "id", "name", "required", "type" ], "additionalProperties": false } }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "strictness": { "type": "string", "enum": [ "strict", "balanced", "flexible" ], "examples": [ "string" ] }, "insert_mode": { "type": "string", "enum": [ "append", "dedup", "merge", "replace" ], "examples": [ "string" ] }, "merge_columns_json": { "anyOf": [ { "minItems": 1, "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "default_sort": { "anyOf": [ { "type": "string", "examples": [ "string" ] }, { "type": "null" } ] }, "row_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "usage_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "data_version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "fts_version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "last_used_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] } }, "required": [ "created_at", "deleted_at", "updated_at", "id", "project_id", "name", "slug", "columns_json", "instruction", "strictness", "insert_mode", "merge_columns_json", "default_sort", "row_count", "usage_count", "data_version", "fts_version", "last_used_at" ], "additionalProperties": false, "x-comb": { "generated": [ "id", "created_at", "updated_at", "deleted_at" ], "identity": "id", "immutable": [ "id", "_search", "project_id", "created_at", "updated_at", "deleted_at" ], "kind": "entity", "name": "table", "softDelete": "deleted_at", "states": null, "tenantColumn": null, "uniqueIndexes": [ { "columns": [ "project_id", "slug" ], "name": "idx_table_project_slug_unique" } ], "v": 1 } }, "Err409TableProjectIdDuplicate": { "type": "object", "properties": { "error_key": { "enum": [ "table_project_id_duplicate" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 409 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "ListProjectsTablesResponse200": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" }, "limit": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "nextCursor": { "type": [ "string", "null" ] }, "page": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tables": { "type": "array", "items": { "type": "object", "properties": { "created_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "deleted_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] }, "updated_at": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, "id": { "type": "string", "minLength": 1, "maxLength": 48, "examples": [ "tbl_01h5a3g8k9m2n4p6q8r0t2v4x6" ] }, "project_id": { "type": "string", "minLength": 1, "maxLength": 48 }, "name": { "type": "string", "minLength": 1, "maxLength": 128, "examples": [ "string" ] }, "slug": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "string" ] }, "columns_json": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "currency_code": { "type": "string", "minLength": 3, "maxLength": 3 }, "default": {}, "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "id": { "type": "string", "minLength": 1, "maxLength": 36 }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "options": { "maxItems": 500, "type": "array", "items": { "type": "string", "maxLength": 256 } }, "required": { "default": false, "type": "boolean" }, "searchable": { "type": "boolean" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } }, "required": [ "id", "name", "required", "type" ], "additionalProperties": false } }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "strictness": { "type": "string", "enum": [ "strict", "balanced", "flexible" ], "examples": [ "string" ] }, "insert_mode": { "type": "string", "enum": [ "append", "dedup", "merge", "replace" ], "examples": [ "string" ] }, "merge_columns_json": { "anyOf": [ { "minItems": 1, "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "default_sort": { "anyOf": [ { "type": "string", "examples": [ "string" ] }, { "type": "null" } ] }, "row_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "usage_count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "data_version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "fts_version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 42 ] }, "last_used_at": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 9007199254740991, "examples": [ 1711468800000 ] }, { "type": "null" } ] } }, "required": [ "created_at", "deleted_at", "updated_at", "id", "project_id", "name", "slug", "columns_json", "instruction", "strictness", "insert_mode", "merge_columns_json", "default_sort", "row_count", "usage_count", "data_version", "fts_version", "last_used_at" ], "additionalProperties": false, "x-comb": { "generated": [ "id", "created_at", "updated_at", "deleted_at" ], "identity": "id", "immutable": [ "id", "_search", "project_id", "created_at", "updated_at", "deleted_at" ], "kind": "entity", "name": "table", "softDelete": "deleted_at", "states": null, "tenantColumn": null, "uniqueIndexes": [ { "columns": [ "project_id", "slug" ], "name": "idx_table_project_slug_unique" } ], "v": 1 } } } }, "required": [ "count", "hasMore", "limit", "nextCursor", "page", "tables" ], "additionalProperties": false }, "CreateProjectsTableRequest": { "type": "object", "properties": { "columns_json": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "currency_code": { "type": "string", "minLength": 3, "maxLength": 3 }, "default": {}, "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "id": { "type": "string", "minLength": 1, "maxLength": 36 }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "options": { "maxItems": 500, "type": "array", "items": { "type": "string", "maxLength": 256 } }, "required": { "default": false, "type": "boolean" }, "searchable": { "type": "boolean" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } }, "required": [ "id", "name" ] } }, "insert_mode": { "type": "string", "enum": [ "append", "dedup", "merge", "replace" ], "examples": [ "string" ] }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "merge_columns_json": { "anyOf": [ { "minItems": 1, "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 128, "examples": [ "string" ] }, "strictness": { "type": "string", "enum": [ "strict", "balanced", "flexible" ], "examples": [ "string" ] } }, "required": [ "columns_json", "name" ] }, "UpdateProjectsTableRequest": { "type": "object", "properties": { "default_sort": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "insert_mode": { "type": "string", "enum": [ "append", "dedup", "merge", "replace" ], "examples": [ "string" ] }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "merge_columns_json": { "anyOf": [ { "minItems": 1, "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 128, "examples": [ "string" ] }, "slug": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "string" ] }, "strictness": { "type": "string", "enum": [ "strict", "balanced", "flexible" ], "examples": [ "string" ] } } }, "CreateProjectsTablesColumnRequest": { "type": "object", "properties": { "currency_code": { "type": "string", "minLength": 3, "maxLength": 3 }, "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "options": { "maxItems": 500, "type": "array", "items": { "type": "string", "maxLength": 256 } }, "required": { "default": false, "type": "boolean" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } }, "required": [ "name" ] }, "Err409OptimisticLockConflict": { "type": "object", "properties": { "error_key": { "enum": [ "optimistic_lock_conflict" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 409 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "ReplaceProjectsTablesColumnRequest": { "type": "object", "properties": { "order": { "minItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "order" ] }, "Err404ColumnNotFoundNotFoundTableNotFound": { "type": "object", "properties": { "error_key": { "enum": [ "column_not_found", "not_found", "table_not_found" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 404 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "UpdateProjectsTablesColumnRequest": { "type": "object", "properties": { "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "options": { "maxItems": 500, "type": "array", "items": { "type": "string", "maxLength": 256 } }, "required": { "default": false, "type": "boolean" }, "searchable": { "type": "boolean" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } } }, "ListProjectsTablesColumnsDistinctResponse200": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": [ "string", "number", "null" ] } } }, "required": [ "values" ], "additionalProperties": false }, "CreateProjectsTablesDuplicateRequest": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128, "examples": [ "string" ] }, "slug": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "string" ] } }, "required": [ "name", "slug" ] }, "ListProjectsTablesExportResponse200": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "const": "processing" } }, "required": [ "id", "status" ], "additionalProperties": false }, "CreateProjectsTablesRestoreRequest": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 50, "examples": [ "string" ] } } }, "ListProjectsTablesRowsResponse200": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "hasMore": { "type": "boolean" }, "limit": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "nextCursor": { "type": [ "string", "null" ] }, "page": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, { "type": "null" } ] }, "rows": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "count", "hasMore", "limit", "nextCursor", "page", "rows" ], "additionalProperties": false }, "CreateProjectsTablesRowRequest": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "ListProjectsTablesRowsResponse200_21d74b": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "number", "null" ] } }, "CreateProjectsTablesRowRequest_dbbb57": { "type": "object", "properties": { "creates": { "maxItems": 1000, "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "deletes": { "maxItems": 1000, "type": "array", "items": { "type": "string" } }, "updates": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "id": { "type": "string" } }, "required": [ "data", "id" ] } } } }, "CreateProjectsTablesRowResponse200": { "type": "object", "properties": { "created": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "deleted": { "type": "array", "items": { "type": "string" } }, "updated": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "additionalProperties": false }, "Err404NotFoundRowNotFoundTableNotFound": { "type": "object", "properties": { "error_key": { "enum": [ "not_found", "row_not_found", "table_not_found" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 404 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "ListProjectsTablesRowsSourceResponse200": {}, "ListProjectsTablesRowsSourceResponse404": { "type": "object", "properties": { "error_key": { "enum": [ "not_found", "row_not_found", "row_source_not_found", "table_not_found" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 404 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "CreateTableTemplateRequest": { "type": "object", "properties": { "category": { "type": "string", "minLength": 1, "maxLength": 64, "examples": [ "string" ] }, "columns_json": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "currency_code": { "type": "string", "minLength": 3, "maxLength": 3 }, "default": {}, "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "id": { "type": "string", "minLength": 1, "maxLength": 36 }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "options": { "maxItems": 500, "type": "array", "items": { "type": "string", "maxLength": 256 } }, "required": { "default": false, "type": "boolean" }, "searchable": { "type": "boolean" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } }, "required": [ "id", "name" ] } }, "description": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "insert_mode": { "type": "string", "enum": [ "append", "dedup", "merge", "replace" ], "examples": [ "string" ] }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "merge_columns_json": { "anyOf": [ { "minItems": 1, "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 128, "examples": [ "string" ] }, "strictness": { "type": "string", "enum": [ "strict", "balanced", "flexible" ], "examples": [ "string" ] } }, "required": [ "category", "columns_json", "name" ] }, "UpdateTableTemplateRequest": { "type": "object", "properties": { "category": { "type": "string", "maxLength": 64, "examples": [ "string" ] }, "columns_json": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "currency_code": { "type": "string", "minLength": 3, "maxLength": 3 }, "default": {}, "description": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "id": { "type": "string", "minLength": 1, "maxLength": 36 }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512 }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[\\w\\s.-]+$" }, "options": { "maxItems": 500, "type": "array", "items": { "type": "string", "maxLength": 256 } }, "required": { "default": false, "type": "boolean" }, "searchable": { "type": "boolean" }, "type": { "default": "string", "type": "string", "enum": [ "array", "boolean", "currency", "date", "email", "enum", "multi_select", "number", "string", "text", "url" ] } }, "required": [ "id", "name" ] } }, "description": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "insert_mode": { "type": "string", "enum": [ "append", "dedup", "merge", "replace" ], "examples": [ "string" ] }, "instruction": { "anyOf": [ { "type": "string", "maxLength": 512, "examples": [ "string" ] }, { "type": "null" } ] }, "merge_columns_json": { "anyOf": [ { "minItems": 1, "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "name": { "type": "string", "maxLength": 128, "examples": [ "string" ] }, "strictness": { "type": "string", "enum": [ "strict", "balanced", "flexible" ], "examples": [ "string" ] } } }, "Err403EmailNotVerifiedForbiddenImpersonationForbiddenOrgSuspendedTableTemplateForbidden": { "type": "object", "properties": { "error_key": { "enum": [ "email_not_verified", "forbidden", "impersonation_forbidden", "org_suspended", "table_template_forbidden" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 403 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "Err404NotFoundTableTemplateNotFound": { "type": "object", "properties": { "error_key": { "enum": [ "not_found", "table_template_not_found" ], "type": "string" }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "error_key": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" } }, "required": [ "error_key", "message", "path" ], "additionalProperties": false } } }, "message": { "type": "string" }, "status": { "enum": [ 404 ], "type": "integer" }, "status_key": { "type": "string" }, "success": { "type": "boolean", "const": false }, "vars": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": [ "string", "number" ] } } }, "required": [ "error_key", "fields", "message", "status", "status_key", "success" ], "additionalProperties": false }, "CreateProjectsExtractResponse200Result": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } } }