{ "components": { "schemas": { "AccountAnalyticsView": { "properties": { "account_id": { "title": "Account Id", "type": "string" }, "available": { "items": { "type": "string" }, "title": "Available", "type": "array" }, "entity_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Ref" }, "follower_history": { "items": { "$ref": "#/components/schemas/SeriesPointView" }, "title": "Follower History", "type": "array" }, "platform": { "title": "Platform", "type": "string" }, "series": { "items": { "$ref": "#/components/schemas/MetricSeriesView" }, "title": "Series", "type": "array" }, "since": { "format": "date", "title": "Since", "type": "string" }, "unavailable": { "items": { "type": "string" }, "title": "Unavailable", "type": "array" }, "until": { "format": "date", "title": "Until", "type": "string" } }, "required": [ "account_id", "platform", "entity_ref", "since", "until", "series", "follower_history", "available", "unavailable" ], "title": "AccountAnalyticsView", "type": "object" }, "AccountEntityView": { "properties": { "external_id": { "title": "External Id", "type": "string" }, "grants": { "items": { "type": "string" }, "title": "Grants", "type": "array" }, "id": { "title": "Id", "type": "string" }, "is_active": { "title": "Is Active", "type": "boolean" }, "kind": { "title": "Kind", "type": "string" }, "last_refreshed_at": { "format": "date-time", "title": "Last Refreshed At", "type": "string" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "name": { "title": "Name", "type": "string" }, "parent_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent External Id" }, "selectable": { "title": "Selectable", "type": "boolean" }, "unselectable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unselectable Reason" } }, "required": [ "id", "kind", "external_id", "name", "parent_external_id", "metadata", "grants", "selectable", "unselectable_reason", "is_active", "last_refreshed_at" ], "title": "AccountEntityView", "type": "object" }, "AccountHealthSummary": { "properties": { "account_id": { "title": "Account Id", "type": "string" }, "health": { "additionalProperties": true, "title": "Health", "type": "object" }, "platform": { "title": "Platform", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "account_id", "platform", "status", "health" ], "title": "AccountHealthSummary", "type": "object" }, "AccountResponse": { "properties": { "active_entity": { "anyOf": [ { "$ref": "#/components/schemas/ActiveEntityView" }, { "type": "null" } ] }, "avatar_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Avatar Url" }, "connected_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Connected At" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "disconnect_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Disconnect Reason" }, "disconnected_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Disconnected At" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "external_identity_id": { "title": "External Identity Id", "type": "string" }, "granted_scopes": { "items": { "type": "string" }, "title": "Granted Scopes", "type": "array" }, "health": { "additionalProperties": true, "title": "Health", "type": "object" }, "id": { "title": "Id", "type": "string" }, "platform": { "title": "Platform", "type": "string" }, "profile_id": { "title": "Profile Id", "type": "string" }, "status": { "title": "Status", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" } }, "required": [ "id", "profile_id", "platform", "external_identity_id", "display_name", "username", "avatar_url", "status", "active_entity", "granted_scopes", "health", "connected_at", "disconnected_at", "disconnect_reason", "created_at", "updated_at" ], "title": "AccountResponse", "type": "object" }, "ActiveEntityView": { "properties": { "external_id": { "title": "External Id", "type": "string" }, "id": { "title": "Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" }, "name": { "title": "Name", "type": "string" }, "parent_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent External Id" } }, "required": [ "id", "kind", "external_id", "name", "parent_external_id" ], "title": "ActiveEntityView", "type": "object" }, "ApiKeyCreateRequest": { "additionalProperties": false, "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "mode": { "default": "live", "enum": [ "live", "test" ], "title": "Mode", "type": "string" }, "name": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "Name" }, "permission": { "$ref": "#/components/schemas/ApiKeyPermission", "default": "read_write" }, "profile_ids": { "default": [], "items": { "type": "string" }, "title": "Profile Ids", "type": "array" }, "scope": { "$ref": "#/components/schemas/ApiKeyScope", "default": "full" } }, "title": "ApiKeyCreateRequest", "type": "object" }, "ApiKeyCreatedResponse": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "id": { "title": "Id", "type": "string" }, "key": { "title": "Key", "type": "string" }, "key_prefix": { "title": "Key Prefix", "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "permission": { "$ref": "#/components/schemas/ApiKeyPermission" }, "profile_ids": { "items": { "type": "string" }, "title": "Profile Ids", "type": "array" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Revoked At" }, "scope": { "$ref": "#/components/schemas/ApiKeyScope" } }, "required": [ "id", "name", "key_prefix", "scope", "profile_ids", "permission", "expires_at", "last_used_at", "revoked_at", "created_at", "key" ], "title": "ApiKeyCreatedResponse", "type": "object" }, "ApiKeyPermission": { "description": "ApiKey.permission - read keys are rejected on all mutations.", "enum": [ "read", "read_write" ], "title": "ApiKeyPermission", "type": "string" }, "ApiKeyResponse": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "id": { "title": "Id", "type": "string" }, "key_prefix": { "title": "Key Prefix", "type": "string" }, "last_used_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Used At" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "permission": { "$ref": "#/components/schemas/ApiKeyPermission" }, "profile_ids": { "items": { "type": "string" }, "title": "Profile Ids", "type": "array" }, "revoked_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Revoked At" }, "scope": { "$ref": "#/components/schemas/ApiKeyScope" } }, "required": [ "id", "name", "key_prefix", "scope", "profile_ids", "permission", "expires_at", "last_used_at", "revoked_at", "created_at" ], "title": "ApiKeyResponse", "type": "object" }, "ApiKeyScope": { "description": "ApiKey.scope - what slice of the tenant the key can see.", "enum": [ "full", "profiles" ], "title": "ApiKeyScope", "type": "string" }, "AsyncDataRequest": { "description": "Request body for async data submission.", "properties": { "action": { "title": "Action", "type": "string" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "query": { "default": "", "title": "Query", "type": "string" }, "webhook_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Webhook Url" } }, "required": [ "action" ], "title": "AsyncDataRequest", "type": "object" }, "AutoTopupRequest": { "properties": { "pack_id": { "title": "Pack Id", "type": "string" }, "threshold": { "title": "Threshold", "type": "number" } }, "required": [ "threshold", "pack_id" ], "title": "AutoTopupRequest", "type": "object" }, "B2BEmailCallbackRequest": { "additionalProperties": true, "description": "B2B-Enrichment email-batch completion callback (permissive: the upstream\nbody mirrors its batch-inquiry response - a batch id plus a ``data`` list\nof items carrying ``refId``/``state``/``output``).", "properties": { "batch_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Batch Id" }, "data": { "default": [], "items": { "additionalProperties": true, "type": "object" }, "title": "Data", "type": "array" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "title": "B2BEmailCallbackRequest", "type": "object" }, "BulkJobRequest": { "description": "Request body for POST /v1/bulk/jobs. Exactly one input source.", "properties": { "action": { "title": "Action", "type": "string" }, "csv_text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Csv Text" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "queries": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Queries" }, "webhook_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Webhook Url" } }, "required": [ "action" ], "title": "BulkJobRequest", "type": "object" }, "CommentView": { "properties": { "account_id": { "title": "Account Id", "type": "string" }, "author": { "additionalProperties": true, "title": "Author", "type": "object" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "can_reply": { "title": "Can Reply", "type": "boolean" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "external_id": { "title": "External Id", "type": "string" }, "external_media_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Media Id" }, "id": { "title": "Id", "type": "string" }, "is_hidden": { "title": "Is Hidden", "type": "boolean" }, "occurred_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Occurred At" }, "parent_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent External Id" }, "platform": { "title": "Platform", "type": "string" } }, "required": [ "id", "account_id", "platform", "external_media_id", "external_id", "parent_external_id", "author", "body", "is_hidden", "can_reply", "occurred_at", "created_at" ], "title": "CommentView", "type": "object" }, "ConsensusRequest": { "description": "Request body for consensus-verified contact lookups.", "properties": { "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "query": { "title": "Query", "type": "string" } }, "required": [ "query" ], "title": "ConsensusRequest", "type": "object" }, "ConversationView": { "properties": { "account_id": { "title": "Account Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "external_id": { "title": "External Id", "type": "string" }, "id": { "title": "Id", "type": "string" }, "last_inbound_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Inbound At" }, "last_message_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Message At" }, "participant": { "additionalProperties": true, "title": "Participant", "type": "object" }, "platform": { "title": "Platform", "type": "string" }, "status": { "title": "Status", "type": "string" }, "unread_count": { "title": "Unread Count", "type": "integer" }, "window_expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Window Expires At" }, "window_open": { "title": "Window Open", "type": "boolean" } }, "required": [ "id", "account_id", "platform", "external_id", "participant", "status", "window_expires_at", "window_open", "last_inbound_at", "last_message_at", "unread_count", "created_at" ], "title": "ConversationView", "type": "object" }, "CreatePostRequest": { "additionalProperties": false, "properties": { "content": { "default": "", "title": "Content", "type": "string" }, "media_ids": { "items": { "type": "string" }, "maxItems": 10, "title": "Media Ids", "type": "array" }, "scheduled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Scheduled At" }, "targets": { "items": { "$ref": "#/components/schemas/TargetRequest" }, "maxItems": 20, "minItems": 1, "title": "Targets", "type": "array" } }, "required": [ "targets" ], "title": "CreatePostRequest", "type": "object" }, "CreateTemplateRequest": { "additionalProperties": false, "properties": { "category": { "title": "Category", "type": "string" }, "components": { "items": { "additionalProperties": true, "type": "object" }, "title": "Components", "type": "array" }, "language": { "maxLength": 32, "minLength": 2, "title": "Language", "type": "string" }, "name": { "maxLength": 512, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name", "language", "category" ], "title": "CreateTemplateRequest", "type": "object" }, "DataRequest": { "description": "Generic request body for data endpoints.", "properties": { "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "query": { "default": "", "title": "Query", "type": "string" }, "since_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Since Cursor" }, "track_delta": { "default": false, "title": "Track Delta", "type": "boolean" } }, "title": "DataRequest", "type": "object" }, "DeliveryResponse": { "properties": { "attempt": { "title": "Attempt", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "delivered_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Delivered At" }, "endpoint_id": { "title": "Endpoint Id", "type": "string" }, "event_id": { "title": "Event Id", "type": "string" }, "event_type": { "title": "Event Type", "type": "string" }, "id": { "title": "Id", "type": "string" }, "last_error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Error" }, "last_response_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Response Code" }, "next_attempt_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Next Attempt At" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "endpoint_id", "event_type", "event_id", "status", "attempt", "next_attempt_at", "last_response_code", "last_error", "delivered_at", "created_at" ], "title": "DeliveryResponse", "type": "object" }, "EntityView": { "properties": { "external_id": { "title": "External Id", "type": "string" }, "grants": { "items": { "type": "string" }, "title": "Grants", "type": "array" }, "kind": { "title": "Kind", "type": "string" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "name": { "title": "Name", "type": "string" }, "parent_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Parent External Id" }, "selectable": { "title": "Selectable", "type": "boolean" }, "unselectable_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Unselectable Reason" } }, "required": [ "kind", "external_id", "name", "parent_external_id", "metadata", "grants", "selectable", "unselectable_reason" ], "title": "EntityView", "type": "object" }, "EstimateRequest": { "description": "Request body for the estimate endpoint.", "properties": { "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "query": { "default": "", "title": "Query", "type": "string" } }, "title": "EstimateRequest", "type": "object" }, "GenericDataRequest": { "description": "Request body for the generic executor.", "properties": { "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "query": { "default": "", "title": "Query", "type": "string" } }, "title": "GenericDataRequest", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "IngestMediaRequest": { "additionalProperties": false, "properties": { "url": { "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "IngestMediaRequest", "type": "object" }, "MediaAssetResponse": { "properties": { "bytes_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Bytes Size" }, "checksum": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Checksum" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "duration_s": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration S" }, "height": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Height" }, "id": { "title": "Id", "type": "string" }, "mime": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mime" }, "public_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Public Url" }, "source_url": { "title": "Source Url", "type": "string" }, "status": { "title": "Status", "type": "string" }, "storage_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Storage Key" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "validation": { "additionalProperties": true, "title": "Validation", "type": "object" }, "width": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Width" } }, "required": [ "id", "status", "source_url", "storage_key", "public_url", "mime", "bytes_size", "width", "height", "duration_s", "checksum", "validation", "created_at", "updated_at" ], "title": "MediaAssetResponse", "type": "object" }, "MessageView": { "properties": { "attachments": { "items": { "additionalProperties": true, "type": "object" }, "title": "Attachments", "type": "array" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "conversation_id": { "title": "Conversation Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "direction": { "title": "Direction", "type": "string" }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Error" }, "external_id": { "title": "External Id", "type": "string" }, "id": { "title": "Id", "type": "string" }, "occurred_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Occurred At" }, "sent_via": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sent Via" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "conversation_id", "direction", "external_id", "body", "attachments", "status", "sent_via", "error", "occurred_at", "created_at" ], "title": "MessageView", "type": "object" }, "MetricSeriesView": { "properties": { "metric": { "title": "Metric", "type": "string" }, "points": { "items": { "$ref": "#/components/schemas/SeriesPointView" }, "title": "Points", "type": "array" } }, "required": [ "metric", "points" ], "title": "MetricSeriesView", "type": "object" }, "ModerateRequest": { "additionalProperties": false, "properties": { "action": { "enum": [ "hide", "unhide", "delete" ], "title": "Action", "type": "string" } }, "required": [ "action" ], "title": "ModerateRequest", "type": "object" }, "ModerateResponse": { "properties": { "action": { "title": "Action", "type": "string" }, "comment": { "anyOf": [ { "$ref": "#/components/schemas/CommentView" }, { "type": "null" } ] } }, "required": [ "comment", "action" ], "title": "ModerateResponse", "type": "object" }, "PageResponse_CommentView_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/CommentView" }, "title": "Data", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "data", "has_more", "next_cursor" ], "title": "PageResponse[CommentView]", "type": "object" }, "PageResponse_ConversationView_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ConversationView" }, "title": "Data", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "data", "has_more", "next_cursor" ], "title": "PageResponse[ConversationView]", "type": "object" }, "PageResponse_MessageView_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/MessageView" }, "title": "Data", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "data", "has_more", "next_cursor" ], "title": "PageResponse[MessageView]", "type": "object" }, "PageResponse_ReviewView_": { "properties": { "data": { "items": { "$ref": "#/components/schemas/ReviewView" }, "title": "Data", "type": "array" }, "has_more": { "title": "Has More", "type": "boolean" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "data", "has_more", "next_cursor" ], "title": "PageResponse[ReviewView]", "type": "object" }, "PostAnalyticsView": { "properties": { "data": { "items": { "$ref": "#/components/schemas/PostMetricsView" }, "title": "Data", "type": "array" }, "unavailable": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "title": "Unavailable", "type": "object" } }, "required": [ "data", "unavailable" ], "title": "PostAnalyticsView", "type": "object" }, "PostMetricsView": { "properties": { "account_id": { "title": "Account Id", "type": "string" }, "as_of": { "format": "date-time", "title": "As Of", "type": "string" }, "metrics": { "additionalProperties": { "type": "number" }, "title": "Metrics", "type": "object" }, "platform": { "title": "Platform", "type": "string" }, "post_id": { "title": "Post Id", "type": "string" } }, "required": [ "post_id", "account_id", "platform", "as_of", "metrics" ], "title": "PostMetricsView", "type": "object" }, "PostResponse": { "properties": { "content": { "title": "Content", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key" }, "media_ids": { "items": { "type": "string" }, "title": "Media Ids", "type": "array" }, "profile_id": { "title": "Profile Id", "type": "string" }, "scheduled_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Scheduled At" }, "status": { "title": "Status", "type": "string" }, "targets": { "items": { "$ref": "#/components/schemas/TargetView" }, "title": "Targets", "type": "array" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "profile_id", "status", "content", "media_ids", "scheduled_at", "idempotency_key", "targets", "created_at", "updated_at" ], "title": "PostResponse", "type": "object" }, "ProfileRequest": { "additionalProperties": false, "properties": { "external_ref": { "anyOf": [ { "maxLength": 255, "type": "string" }, { "type": "null" } ], "title": "External Ref" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "name": { "maxLength": 255, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "name" ], "title": "ProfileRequest", "type": "object" }, "ProfileResponse": { "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "external_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Ref" }, "id": { "title": "Id", "type": "string" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "name": { "title": "Name", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" } }, "required": [ "id", "name", "external_ref", "metadata", "created_at", "updated_at" ], "title": "ProfileResponse", "type": "object" }, "RegisterNumberRequest": { "additionalProperties": false, "properties": { "data_localization_region": { "anyOf": [ { "maxLength": 2, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Data Localization Region" }, "pin": { "maxLength": 6, "minLength": 6, "pattern": "^\\d{6}$", "title": "Pin", "type": "string" } }, "required": [ "pin" ], "title": "RegisterNumberRequest", "type": "object" }, "RegisterNumberResponse": { "properties": { "account_id": { "title": "Account Id", "type": "string" }, "phone_number_id": { "title": "Phone Number Id", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "account_id", "phone_number_id", "status" ], "title": "RegisterNumberResponse", "type": "object" }, "ReplyRequest": { "additionalProperties": false, "properties": { "body": { "maxLength": 10000, "minLength": 1, "title": "Body", "type": "string" } }, "required": [ "body" ], "title": "ReplyRequest", "type": "object" }, "ReviewView": { "properties": { "account_id": { "title": "Account Id", "type": "string" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "entity_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity External Id" }, "external_id": { "title": "External Id", "type": "string" }, "id": { "title": "Id", "type": "string" }, "occurred_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Occurred At" }, "platform": { "title": "Platform", "type": "string" }, "rating": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rating" }, "reply_body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reply Body" }, "reply_state": { "title": "Reply State", "type": "string" }, "reviewer": { "additionalProperties": true, "title": "Reviewer", "type": "object" } }, "required": [ "id", "account_id", "platform", "entity_external_id", "external_id", "rating", "body", "reviewer", "reply_body", "reply_state", "occurred_at", "created_at" ], "title": "ReviewView", "type": "object" }, "RotatedSecretResponse": { "properties": { "id": { "title": "Id", "type": "string" }, "previous_secret_expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Previous Secret Expires At" }, "rotated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Rotated At" }, "secret": { "title": "Secret", "type": "string" } }, "required": [ "id", "secret", "previous_secret_expires_at", "rotated_at" ], "title": "RotatedSecretResponse", "type": "object" }, "SendMessageRequest": { "additionalProperties": false, "properties": { "tag": { "anyOf": [ { "const": "human_agent", "type": "string" }, { "type": "null" } ], "title": "Tag" }, "template": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Template" }, "text": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ], "title": "Text" } }, "title": "SendMessageRequest", "type": "object" }, "SeriesPointView": { "properties": { "day": { "format": "date", "title": "Day", "type": "string" }, "synthesized": { "title": "Synthesized", "type": "boolean" }, "value": { "title": "Value", "type": "number" } }, "required": [ "day", "value", "synthesized" ], "title": "SeriesPointView", "type": "object" }, "SessionEntitiesResponse": { "properties": { "entities": { "items": { "$ref": "#/components/schemas/EntityView" }, "title": "Entities", "type": "array" }, "phase": { "title": "Phase", "type": "string" }, "platform": { "title": "Platform", "type": "string" }, "session_id": { "title": "Session Id", "type": "string" } }, "required": [ "session_id", "platform", "phase", "entities" ], "title": "SessionEntitiesResponse", "type": "object" }, "StartConnectResponse": { "properties": { "auth_url": { "title": "Auth Url", "type": "string" }, "connect_token": { "title": "Connect Token", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "mode": { "title": "Mode", "type": "string" }, "platform": { "title": "Platform", "type": "string" }, "session_id": { "title": "Session Id", "type": "string" }, "state": { "title": "State", "type": "string" } }, "required": [ "session_id", "platform", "mode", "auth_url", "state", "connect_token", "expires_at" ], "title": "StartConnectResponse", "type": "object" }, "StartConversationRequest": { "additionalProperties": false, "properties": { "account_id": { "title": "Account Id", "type": "string" }, "recipient": { "maxLength": 255, "minLength": 1, "title": "Recipient", "type": "string" }, "template": { "additionalProperties": true, "title": "Template", "type": "object" }, "text": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "null" } ], "title": "Text" } }, "required": [ "account_id", "recipient", "template" ], "title": "StartConversationRequest", "type": "object" }, "StartConversationResponse": { "properties": { "conversation": { "$ref": "#/components/schemas/ConversationView" }, "message": { "$ref": "#/components/schemas/MessageView" } }, "required": [ "conversation", "message" ], "title": "StartConversationResponse", "type": "object" }, "SwitchEntityRequest": { "additionalProperties": false, "properties": { "entity_external_id": { "title": "Entity External Id", "type": "string" } }, "required": [ "entity_external_id" ], "title": "SwitchEntityRequest", "type": "object" }, "TargetRequest": { "additionalProperties": false, "properties": { "account_id": { "title": "Account Id", "type": "string" }, "platform_specific_data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Platform Specific Data" } }, "required": [ "account_id" ], "title": "TargetRequest", "type": "object" }, "TargetView": { "properties": { "account_id": { "title": "Account Id", "type": "string" }, "attempt": { "title": "Attempt", "type": "integer" }, "deadline_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Deadline At" }, "entity_external_id": { "title": "Entity External Id", "type": "string" }, "error": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Error" }, "external_post_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Post Id" }, "id": { "title": "Id", "type": "string" }, "next_action_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Next Action At" }, "permalink": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permalink" }, "platform": { "title": "Platform", "type": "string" }, "published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Published At" }, "state": { "title": "State", "type": "string" }, "warnings": { "items": { "type": "string" }, "title": "Warnings", "type": "array" } }, "required": [ "id", "account_id", "platform", "entity_external_id", "state", "attempt", "external_post_id", "permalink", "error", "next_action_at", "deadline_at", "published_at" ], "title": "TargetView", "type": "object" }, "TemplateView": { "properties": { "category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Category" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "id": { "title": "Id", "type": "string" }, "language": { "title": "Language", "type": "string" }, "name": { "title": "Name", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "id", "name", "language", "status", "category", "external_id" ], "title": "TemplateView", "type": "object" }, "TestFireResponse": { "properties": { "delivered": { "title": "Delivered", "type": "boolean" }, "delivery": { "$ref": "#/components/schemas/DeliveryResponse" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "response_code": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Response Code" } }, "required": [ "delivery", "delivered", "response_code", "error" ], "title": "TestFireResponse", "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" }, "WebhookEndpointCreate": { "additionalProperties": false, "properties": { "active": { "default": true, "title": "Active", "type": "boolean" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "subscribed_events": { "items": { "type": "string" }, "title": "Subscribed Events", "type": "array" }, "url": { "maxLength": 2048, "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "WebhookEndpointCreate", "type": "object" }, "WebhookEndpointCreatedResponse": { "properties": { "active": { "title": "Active", "type": "boolean" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "previous_secret_expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Previous Secret Expires At" }, "rotated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Rotated At" }, "secret": { "title": "Secret", "type": "string" }, "subscribed_events": { "items": { "type": "string" }, "title": "Subscribed Events", "type": "array" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "id", "url", "subscribed_events", "active", "rotated_at", "previous_secret_expires_at", "metadata", "created_at", "updated_at", "secret" ], "title": "WebhookEndpointCreatedResponse", "type": "object" }, "WebhookEndpointResponse": { "properties": { "active": { "title": "Active", "type": "boolean" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "title": "Id", "type": "string" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "previous_secret_expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Previous Secret Expires At" }, "rotated_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Rotated At" }, "subscribed_events": { "items": { "type": "string" }, "title": "Subscribed Events", "type": "array" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "url": { "title": "Url", "type": "string" } }, "required": [ "id", "url", "subscribed_events", "active", "rotated_at", "previous_secret_expires_at", "metadata", "created_at", "updated_at" ], "title": "WebhookEndpointResponse", "type": "object" }, "WebhookEndpointUpdate": { "additionalProperties": false, "properties": { "active": { "default": true, "title": "Active", "type": "boolean" }, "metadata": { "additionalProperties": true, "title": "Metadata", "type": "object" }, "subscribed_events": { "items": { "type": "string" }, "title": "Subscribed Events", "type": "array" }, "url": { "maxLength": 2048, "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "WebhookEndpointUpdate", "type": "object" }, "WorkflowRequest": { "description": "Request body for workflow runs and estimates.\n\nWorkflow-specific inputs (emails, industries, verify_emails, ...) go in\n``inputs``; top-level ``query``/``filters``/``limit`` are merged in and\ntake precedence when set.", "properties": { "dry_run": { "default": false, "title": "Dry Run", "type": "boolean" }, "filters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filters" }, "format": { "default": "json", "enum": [ "json", "markdown", "csv" ], "title": "Format", "type": "string" }, "inputs": { "additionalProperties": true, "title": "Inputs", "type": "object" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "query": { "default": "", "title": "Query", "type": "string" } }, "title": "WorkflowRequest", "type": "object" } }, "securitySchemes": { "HTTPBearer": { "scheme": "bearer", "type": "http" } } }, "info": { "title": "QannasAPI", "version": "0.1.0" }, "openapi": "3.1.0", "paths": { "/status/rates": { "get": { "description": "Per-series collection freshness for the UAE rates & calendar data.", "operationId": "rates_status_status_rates_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Rates Status Status Rates Get", "type": "object" } } }, "description": "Successful Response" } }, "summary": "Rates Status", "tags": [ "public" ] } }, "/v1/accounts": { "get": { "operationId": "list_accounts_v1_accounts_get", "parameters": [ { "in": "query", "name": "profile_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id" } }, { "in": "query", "name": "platform", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AccountResponse" }, "title": "Response List Accounts V1 Accounts Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Accounts", "tags": [ "accounts" ] } }, "/v1/accounts/health": { "get": { "description": "Stored health snapshots for every visible account (no platform calls).", "operationId": "list_account_health_v1_accounts_health_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AccountHealthSummary" }, "title": "Response List Account Health V1 Accounts Health Get", "type": "array" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Account Health", "tags": [ "accounts" ] } }, "/v1/accounts/{account_id}": { "delete": { "operationId": "disconnect_account_v1_accounts__account_id__delete", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Disconnect Account", "tags": [ "accounts" ] }, "get": { "operationId": "get_account_v1_accounts__account_id__get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Account", "tags": [ "accounts" ] } }, "/v1/accounts/{account_id}/entities": { "get": { "operationId": "list_account_entities_v1_accounts__account_id__entities_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "query", "name": "refresh", "required": false, "schema": { "default": false, "title": "Refresh", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AccountEntityView" }, "title": "Response List Account Entities V1 Accounts Account Id Entities Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Account Entities", "tags": [ "accounts" ] } }, "/v1/accounts/{account_id}/entity": { "put": { "description": "Switch the active entity WITHOUT re-auth (re-runs activation only).", "operationId": "switch_account_entity_v1_accounts__account_id__entity_put", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchEntityRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Switch Account Entity", "tags": [ "accounts" ] } }, "/v1/accounts/{account_id}/health": { "get": { "description": "Live adapter probe; updates and returns the stored snapshot.", "operationId": "check_account_health_v1_accounts__account_id__health_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountHealthSummary" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Check Account Health", "tags": [ "accounts" ] } }, "/v1/analytics": { "get": { "operationId": "list_post_analytics_v1_analytics_get", "parameters": [ { "in": "query", "name": "account_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, { "in": "query", "name": "platform", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, { "in": "query", "name": "since", "required": false, "schema": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "in": "query", "name": "until", "required": false, "schema": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Until" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 200, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostAnalyticsView" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Post Analytics", "tags": [ "analytics" ] } }, "/v1/analytics/accounts/{account_id}": { "get": { "operationId": "account_analytics_v1_analytics_accounts__account_id__get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } }, { "in": "query", "name": "since", "required": false, "schema": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Since" } }, { "in": "query", "name": "until", "required": false, "schema": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Until" } }, { "in": "query", "name": "metric", "required": false, "schema": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Metric" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountAnalyticsView" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Account Analytics", "tags": [ "analytics" ] } }, "/v1/api-keys": { "get": { "operationId": "list_api_keys_v1_api_keys_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ApiKeyResponse" }, "title": "Response List Api Keys V1 Api Keys Get", "type": "array" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Api Keys", "tags": [ "api-keys" ] }, "post": { "operationId": "create_api_key_v1_api_keys_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreatedResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Api Key", "tags": [ "api-keys" ] } }, "/v1/api-keys/{api_key_id}": { "delete": { "operationId": "revoke_api_key_v1_api_keys__api_key_id__delete", "parameters": [ { "in": "path", "name": "api_key_id", "required": true, "schema": { "title": "Api Key Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Revoke Api Key", "tags": [ "api-keys" ] } }, "/v1/billing/auto-topup": { "post": { "description": "Enable auto-top-up: when balance drops below threshold, buy a pack.", "operationId": "enable_auto_topup_v1_billing_auto_topup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutoTopupRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Enable Auto Topup V1 Billing Auto Topup Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Enable Auto Topup", "tags": [ "billing" ] } }, "/v1/billing/invoices": { "get": { "description": "List invoices for this tenant.", "operationId": "list_invoices_v1_billing_invoices_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Invoices V1 Billing Invoices Get", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Invoices", "tags": [ "billing" ] } }, "/v1/billing/packs": { "get": { "description": "Public credit pack price list (PRD §6: transparency is the anti-ZoomInfo weapon).", "operationId": "list_packs_v1_billing_packs_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Packs V1 Billing Packs Get", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Packs", "tags": [ "billing" ] } }, "/v1/billing/packs/{pack_id}/purchase": { "post": { "description": "Purchase a credit pack.\n\nStripe enabled → 202-style pending result carrying the Checkout URL;\n credits land when the webhook confirms payment.\nStripe disabled → non-prod only: instant SIMULATED grant (simulated=true);\n in prod this route refuses with 503 billing_not_configured.", "operationId": "purchase_credits_v1_billing_packs__pack_id__purchase_post", "parameters": [ { "in": "path", "name": "pack_id", "required": true, "schema": { "title": "Pack Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Purchase Credits V1 Billing Packs Pack Id Purchase Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Purchase Credits", "tags": [ "billing" ] } }, "/v1/billing/plans": { "get": { "description": "Public subscription plan list.", "operationId": "list_plans_v1_billing_plans_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Plans V1 Billing Plans Get", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Plans", "tags": [ "billing" ] } }, "/v1/billing/portal": { "post": { "description": "Create a Stripe Customer Portal session; returns ``{\"url\": ...}``.\n\nThe Stripe customer id is resolved live from the tenant's Stripe-backed\nsubscription (it is not persisted locally). 503 when Stripe is disabled;\n404 when the tenant has no Stripe customer yet (never subscribed via\nStripe).", "operationId": "create_portal_session_v1_billing_portal_post", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Portal Session V1 Billing Portal Post", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Portal Session", "tags": [ "billing" ] } }, "/v1/billing/subscriptions": { "delete": { "description": "Cancel the active subscription.\n\nStripe-backed subs are cancelled at Stripe with ``cancel_at_period_end``\n(the customer keeps the paid period; ``customer.subscription.deleted``\nfinalises it at period end — no new event type needed) and cancelled\nlocally at once. Stripe disabled + a real Stripe subscription → 503:\na local-only cancel would silently strand a still-billed customer.\nSimulated subs (no Stripe id) cancel locally, as before.", "operationId": "cancel_subscription_v1_billing_subscriptions_delete", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Cancel Subscription V1 Billing Subscriptions Delete", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Cancel Subscription", "tags": [ "billing" ] } }, "/v1/billing/subscriptions/{plan_id}": { "post": { "description": "Subscribe to a monthly plan (same Stripe/simulated split as packs).", "operationId": "subscribe_v1_billing_subscriptions__plan_id__post", "parameters": [ { "in": "path", "name": "plan_id", "required": true, "schema": { "title": "Plan Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Subscribe V1 Billing Subscriptions Plan Id Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Subscribe", "tags": [ "billing" ] } }, "/v1/billing/usage": { "get": { "description": "Usage dashboard: balance, subscription, total spent, credits purchased.", "operationId": "get_usage_v1_billing_usage_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Get Usage V1 Billing Usage Get", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Usage", "tags": [ "billing" ] } }, "/v1/bulk/jobs": { "get": { "description": "List the caller's jobs, newest first.", "operationId": "list_bulk_jobs_v1_bulk_jobs_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Bulk Jobs V1 Bulk Jobs Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Bulk Jobs", "tags": [ "bulk" ] }, "post": { "description": "Submit (and inline-run) a bulk job. Returns the completed summary.", "operationId": "create_bulk_job_v1_bulk_jobs_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkJobRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Bulk Job V1 Bulk Jobs Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Bulk Job", "tags": [ "bulk" ] } }, "/v1/bulk/jobs/{job_id}": { "get": { "description": "Job status + progress + stats (no result_rows).", "operationId": "get_bulk_job_v1_bulk_jobs__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Get Bulk Job V1 Bulk Jobs Job Id Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Bulk Job", "tags": [ "bulk" ] } }, "/v1/bulk/jobs/{job_id}/result": { "get": { "description": "Per-row results as a JSON envelope, or a flattened CSV download.", "operationId": "get_bulk_job_result_v1_bulk_jobs__job_id__result_get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } }, { "in": "query", "name": "format", "required": false, "schema": { "default": "json", "enum": [ "json", "csv" ], "title": "Format", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Bulk Job Result", "tags": [ "bulk" ] } }, "/v1/calendar/uae/holidays": { "get": { "description": "UAE public holidays, one row per day, oldest first.\n\n``sector`` defaults to the private-sector (banking/business) view. Filter\nby ``status`` to separate confirmed days from Hijri projections.", "operationId": "list_holidays_v1_calendar_uae_holidays_get", "parameters": [ { "in": "query", "name": "year", "required": false, "schema": { "anyOf": [ { "maximum": 2100, "minimum": 2000, "type": "integer" }, { "type": "null" } ], "title": "Year" } }, { "description": "public|private|both", "in": "query", "name": "sector", "required": false, "schema": { "default": "private", "description": "public|private|both", "title": "Sector", "type": "string" } }, { "description": "expected|announced|observed", "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "expected|announced|observed", "title": "Status" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Holidays V1 Calendar Uae Holidays Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Holidays", "tags": [ "calendar" ] } }, "/v1/calendar/uae/is-holiday": { "get": { "description": "Whether a date is a UAE public holiday (and whether it is a work day).", "operationId": "is_holiday_v1_calendar_uae_is_holiday_get", "parameters": [ { "description": "YYYY-MM-DD", "in": "query", "name": "date", "required": true, "schema": { "description": "YYYY-MM-DD", "title": "Date", "type": "string" } }, { "description": "public|private|both", "in": "query", "name": "sector", "required": false, "schema": { "default": "private", "description": "public|private|both", "title": "Sector", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Is Holiday V1 Calendar Uae Is Holiday Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Is Holiday", "tags": [ "calendar" ] } }, "/v1/calendar/uae/long-weekends": { "get": { "description": "Runs of consecutive non-working days in ``year`` (weekend + holidays).", "operationId": "long_weekends_v1_calendar_uae_long_weekends_get", "parameters": [ { "in": "query", "name": "year", "required": true, "schema": { "maximum": 2100, "minimum": 2000, "title": "Year", "type": "integer" } }, { "description": "public|private|both", "in": "query", "name": "sector", "required": false, "schema": { "default": "private", "description": "public|private|both", "title": "Sector", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Long Weekends V1 Calendar Uae Long Weekends Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Long Weekends", "tags": [ "calendar" ] } }, "/v1/calendar/uae/next-holiday": { "get": { "description": "The next holiday strictly after ``after`` (default: today, UTC).", "operationId": "next_holiday_v1_calendar_uae_next_holiday_get", "parameters": [ { "description": "YYYY-MM-DD; defaults to today", "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "YYYY-MM-DD; defaults to today", "title": "After" } }, { "description": "public|private|both", "in": "query", "name": "sector", "required": false, "schema": { "default": "private", "description": "public|private|both", "title": "Sector", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Next Holiday V1 Calendar Uae Next Holiday Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Next Holiday", "tags": [ "calendar" ] } }, "/v1/calendar/uae/working-days": { "get": { "description": "Count UAE working days in an inclusive date range.\n\nWeekends follow the era rule (Sat-Sun since 2022-01-01, Fri-Sat before),\nand public holidays for ``sector`` are excluded.", "operationId": "working_days_v1_calendar_uae_working_days_get", "parameters": [ { "description": "YYYY-MM-DD", "in": "query", "name": "from", "required": true, "schema": { "description": "YYYY-MM-DD", "title": "From", "type": "string" } }, { "description": "YYYY-MM-DD", "in": "query", "name": "to", "required": true, "schema": { "description": "YYYY-MM-DD", "title": "To", "type": "string" } }, { "description": "public|private|both", "in": "query", "name": "sector", "required": false, "schema": { "default": "private", "description": "public|private|both", "title": "Sector", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Working Days V1 Calendar Uae Working Days Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Working Days", "tags": [ "calendar" ] } }, "/v1/connect/{platform}": { "get": { "operationId": "start_connect_v1_connect__platform__get", "parameters": [ { "in": "path", "name": "platform", "required": true, "schema": { "title": "Platform", "type": "string" } }, { "in": "query", "name": "profile_id", "required": true, "schema": { "title": "Profile Id", "type": "string" } }, { "in": "query", "name": "redirect_url", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Redirect Url" } }, { "in": "query", "name": "headless", "required": false, "schema": { "default": false, "title": "Headless", "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartConnectResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Start Connect", "tags": [ "connect" ] } }, "/v1/connect/{platform}/entities": { "get": { "description": "Discovered entities for one connect session (headless flow).", "operationId": "session_entities_v1_connect__platform__entities_get", "parameters": [ { "in": "path", "name": "platform", "required": true, "schema": { "title": "Platform", "type": "string" } }, { "in": "header", "name": "X-Connect-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Connect-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SessionEntitiesResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Session Entities", "tags": [ "connect" ] } }, "/v1/connect/{platform}/select": { "post": { "description": "Finalize the entity choice: activate, mint the SocialAccount, write\nrouting keys. JSON+header for headless; form post from the hosted picker.", "operationId": "select_entity_v1_connect__platform__select_post", "parameters": [ { "in": "path", "name": "platform", "required": true, "schema": { "title": "Platform", "type": "string" } }, { "in": "header", "name": "X-Connect-Token", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Connect-Token" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Select Entity", "tags": [ "connect" ] } }, "/v1/data/ads/details": { "post": { "operationId": "ads_details_v1_data_ads_details_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Ads Details V1 Data Ads Details Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Ads Details", "tags": [ "data" ] } }, "/v1/data/ads/search": { "post": { "operationId": "ads_search_v1_data_ads_search_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Ads Search V1 Data Ads Search Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Ads Search", "tags": [ "data" ] } }, "/v1/data/ai/enrich": { "post": { "operationId": "ai_enrich_v1_data_ai_enrich_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Ai Enrich V1 Data Ai Enrich Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Ai Enrich", "tags": [ "data" ] } }, "/v1/data/companies/enrich": { "post": { "operationId": "enrich_company_v1_data_companies_enrich_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Enrich Company V1 Data Companies Enrich Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Enrich Company", "tags": [ "data" ] } }, "/v1/data/companies/funding": { "post": { "operationId": "company_funding_v1_data_companies_funding_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Company Funding V1 Data Companies Funding Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Company Funding", "tags": [ "data" ] } }, "/v1/data/contacts/find-email": { "post": { "operationId": "find_email_v1_data_contacts_find_email_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Find Email V1 Data Contacts Find Email Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Find Email", "tags": [ "data" ] } }, "/v1/data/contacts/find-email-verified": { "post": { "description": "Find an email across up to 3 providers; 2+ sources -> verified.", "operationId": "find_email_verified_v1_data_contacts_find_email_verified_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsensusRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Find Email Verified V1 Data Contacts Find Email Verified Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Find Email Verified", "tags": [ "data" ] } }, "/v1/data/contacts/find-phone": { "post": { "operationId": "find_phone_v1_data_contacts_find_phone_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Find Phone V1 Data Contacts Find Phone Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Find Phone", "tags": [ "data" ] } }, "/v1/data/contacts/find-phone-verified": { "post": { "description": "Find a phone number across up to 3 providers; 2+ sources -> verified.", "operationId": "find_phone_verified_v1_data_contacts_find_phone_verified_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsensusRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Find Phone Verified V1 Data Contacts Find Phone Verified Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Find Phone Verified", "tags": [ "data" ] } }, "/v1/data/contacts/reverse-lookup": { "post": { "operationId": "reverse_lookup_v1_data_contacts_reverse_lookup_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Reverse Lookup V1 Data Contacts Reverse Lookup Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Reverse Lookup", "tags": [ "data" ] } }, "/v1/data/contacts/verify-email": { "post": { "operationId": "verify_email_v1_data_contacts_verify_email_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Verify Email V1 Data Contacts Verify Email Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Verify Email", "tags": [ "data" ] } }, "/v1/data/events/search": { "post": { "description": "UAE trade shows and exhibitions (DWTC Dubai, then ADNEC Abu Dhabi).\n\n``query`` narrows on the event name; ``filters.country`` (``ae``) scopes\nthe venue — any other country is a free scoped miss. Rows carry the\npublished date range, hall assignment and canonical URL, which is what\nexhibitor-outreach workflows key off, plus the organiser and the event's\nown site where the venue publishes them.\n\nDWTC also honours ``filters.sector`` (its own classification, e.g.\n``healthcare``), ``filters.starts_after`` / ``starts_before`` (ISO dates),\n``filters.include_past`` (default false — \"what's on\" means upcoming) and\n``filters.enrich`` (default true; set false to skip the per-row detail\nfetch when names and dates are enough).\n\nUnpaginated: both venues expose full snapshots rather than paged feeds, so\nnarrow with ``query``/filters rather than paging.", "operationId": "events_search_v1_data_events_search_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Events Search V1 Data Events Search Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Events Search", "tags": [ "data" ] } }, "/v1/data/listings/agent": { "post": { "description": "All listings for one agent/agency. ``filters.agent_url`` (or a dubizzle\nagent page URL in ``query``); ``cursor`` carries the page number.", "operationId": "agent_listings_v1_data_listings_agent_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Agent Listings V1 Data Listings Agent Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Agent Listings", "tags": [ "data" ] } }, "/v1/data/listings/details": { "post": { "description": "One listing's details. ``filters.url`` (or a dubizzle URL in ``query``).", "operationId": "listing_details_v1_data_listings_details_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Listing Details V1 Data Listings Details Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Listing Details", "tags": [ "data" ] } }, "/v1/data/listings/phone": { "post": { "description": "Reveal a listing's phone number + seller name (premium action).\n\n``filters.url`` (or a dubizzle listing URL in ``query``). Sync-only: the\nupstream phone endpoint is token-gated per click, so the provider drives a\nreal browser session — expect ~15-30s latency. Search hits carry\n``attributes.has_phone_number`` so callers can pre-filter.", "operationId": "listing_phone_v1_data_listings_phone_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Listing Phone V1 Data Listings Phone Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Listing Phone", "tags": [ "data" ] } }, "/v1/data/listings/search": { "post": { "description": "Classifieds listings search (property/motors/jobs).\n\n``query`` is the keyword search; ``filters.city`` / ``filters.category`` /\n``filters.subcategory`` / ``filters.price_min`` / ``filters.price_max``\nshape the upstream search URL; ``cursor`` carries the page number.\n\nGeography: ``filters.country`` = sa/eg/bh/kw/om/qa routes to the dubizzle\nGroup horizontal family (dubizzle.sa, dubizzle.com.eg, OLX GCC); omitting\nit (or \"ae\") routes to dubizzle.com UAE. On the horizontal family,\nkeywords and range filters are post-filtered locally (45/page).", "operationId": "listings_search_v1_data_listings_search_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Listings Search V1 Data Listings Search Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Listings Search", "tags": [ "data" ] } }, "/v1/data/maps/places": { "post": { "operationId": "maps_places_v1_data_maps_places_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Maps Places V1 Data Maps Places Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Maps Places", "tags": [ "data" ] } }, "/v1/data/people/enrich": { "post": { "operationId": "enrich_person_v1_data_people_enrich_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Enrich Person V1 Data People Enrich Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Enrich Person", "tags": [ "data" ] } }, "/v1/data/products/details": { "post": { "description": "One product's full record incl. seller + variants + specs.\n\n``filters.url`` (a noon.com product URL — market from the path) or\n``filters.sku`` + ``filters.country``. The response's ``seller`` block\n(name, partner_code, rating, positive_rating_pct) and per-variant offers\nare the seller-monitor surface.", "operationId": "product_details_v1_data_products_details_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Product Details V1 Data Products Details Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Product Details", "tags": [ "data" ] } }, "/v1/data/products/search": { "post": { "description": "Marketplace product search (noon.com ae/sa/eg).\n\n``query`` is the keyword search; ``filters.country`` (REQUIRED: ae|sa|eg)\npicks the market; ``filters.price_min`` / ``filters.price_max`` /\n``filters.sort`` (popularity|price_asc|price_desc) are honored upstream;\n``cursor`` carries the page number. Hits include price/was_price/rating/\nreview_count, the ``offer_code`` and the buy-box ``seller`` (name +\nrating); ``/products/details`` adds partner_code, badges and the\ncompeting per-variant offers.", "operationId": "product_search_v1_data_products_search_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Product Search V1 Data Products Search Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Product Search", "tags": [ "data" ] } }, "/v1/data/search/companies": { "post": { "operationId": "search_companies_v1_data_search_companies_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Search Companies V1 Data Search Companies Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Search Companies", "tags": [ "data" ] } }, "/v1/data/search/employees": { "post": { "description": "Employees of a company (decision-maker discovery).\n\nRequest mapping: ``filters.company_linkedin_url`` (preferred) or a\nLinkedIn company URL in ``query``; ``limit`` defaults to 10, capped at\n50; ``cursor`` carries the upstream page number (same convention as\n/search/people).", "operationId": "search_company_employees_v1_data_search_employees_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Search Company Employees V1 Data Search Employees Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Search Company Employees", "tags": [ "data" ] } }, "/v1/data/search/lookalikes": { "post": { "description": "Lookalike companies for a seed domain (Ocean.io — synchronous).", "operationId": "search_lookalikes_v1_data_search_lookalikes_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Search Lookalikes V1 Data Search Lookalikes Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Search Lookalikes", "tags": [ "data" ] } }, "/v1/data/search/people": { "post": { "operationId": "search_people_v1_data_search_people_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Search People V1 Data Search People Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Search People", "tags": [ "data" ] } }, "/v1/data/seo/serp": { "post": { "operationId": "seo_serp_v1_data_seo_serp_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Seo Serp V1 Data Seo Serp Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Seo Serp", "tags": [ "data" ] } }, "/v1/data/signals/funding-events": { "post": { "description": "Companies with funding events in a window (Ocean.io filter — sync).", "operationId": "signals_funding_events_v1_data_signals_funding_events_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Signals Funding Events V1 Data Signals Funding Events Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Signals Funding Events", "tags": [ "data" ] } }, "/v1/data/signals/headcount-growth": { "post": { "description": "Companies with headcount growth in a window (Ocean.io filter — sync).", "operationId": "signals_headcount_growth_v1_data_signals_headcount_growth_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Signals Headcount Growth V1 Data Signals Headcount Growth Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Signals Headcount Growth", "tags": [ "data" ] } }, "/v1/data/websites/contacts": { "post": { "operationId": "website_contacts_v1_data_websites_contacts_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Contacts V1 Data Websites Contacts Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Contacts", "tags": [ "data" ] } }, "/v1/data/websites/intelligence": { "post": { "operationId": "website_intelligence_v1_data_websites_intelligence_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Intelligence V1 Data Websites Intelligence Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Intelligence", "tags": [ "data" ] } }, "/v1/data/websites/json-ld": { "post": { "operationId": "website_json_ld_v1_data_websites_json_ld_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Json Ld V1 Data Websites Json Ld Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Json Ld", "tags": [ "data" ] } }, "/v1/data/websites/meta-tags": { "post": { "operationId": "website_meta_tags_v1_data_websites_meta_tags_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Meta Tags V1 Data Websites Meta Tags Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Meta Tags", "tags": [ "data" ] } }, "/v1/data/websites/pixels": { "post": { "operationId": "website_pixels_v1_data_websites_pixels_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Pixels V1 Data Websites Pixels Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Pixels", "tags": [ "data" ] } }, "/v1/data/websites/resolve": { "post": { "operationId": "website_resolve_v1_data_websites_resolve_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Resolve V1 Data Websites Resolve Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Resolve", "tags": [ "data" ] } }, "/v1/data/websites/scrape": { "post": { "operationId": "website_scrape_v1_data_websites_scrape_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Scrape V1 Data Websites Scrape Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Scrape", "tags": [ "data" ] } }, "/v1/data/websites/similarweb": { "post": { "operationId": "website_similarweb_v1_data_websites_similarweb_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Similarweb V1 Data Websites Similarweb Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Similarweb", "tags": [ "data" ] } }, "/v1/data/websites/sitemap": { "post": { "operationId": "website_sitemap_v1_data_websites_sitemap_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Sitemap V1 Data Websites Sitemap Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Sitemap", "tags": [ "data" ] } }, "/v1/data/websites/social-links": { "post": { "operationId": "website_social_links_v1_data_websites_social_links_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Social Links V1 Data Websites Social Links Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Social Links", "tags": [ "data" ] } }, "/v1/data/websites/tech-stack": { "post": { "operationId": "website_tech_stack_v1_data_websites_tech_stack_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Website Tech Stack V1 Data Websites Tech Stack Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Website Tech Stack", "tags": [ "data" ] } }, "/v1/data/workflows": { "get": { "description": "List available workflows with input schemas and indicative credit ranges.", "operationId": "list_workflows_v1_data_workflows_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Workflows V1 Data Workflows Get", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Workflows", "tags": [ "workflows" ] } }, "/v1/data/workflows/{name}": { "post": { "description": "Run a workflow end-to-end. Credit headers report the workflow total.", "operationId": "run_workflow_v1_data_workflows__name__post", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Run Workflow V1 Data Workflows Name Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Run Workflow", "tags": [ "workflows" ] } }, "/v1/data/workflows/{name}:estimate": { "post": { "description": "Pre-run estimate: per-step credit breakdown. No execution, no charge.", "operationId": "estimate_workflow_v1_data_workflows__name__estimate_post", "parameters": [ { "in": "path", "name": "name", "required": true, "schema": { "title": "Name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Estimate Workflow V1 Data Workflows Name Estimate Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Estimate Workflow", "tags": [ "workflows" ] } }, "/v1/data/x/{endpoint_key}": { "post": { "description": "Execute one catalog-mapped generic endpoint for the caller's tenant.", "operationId": "execute_generic_v1_data_x__endpoint_key__post", "parameters": [ { "in": "path", "name": "endpoint_key", "required": true, "schema": { "title": "Endpoint Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericDataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Execute Generic V1 Data X Endpoint Key Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Execute Generic", "tags": [ "data" ] } }, "/v1/data/youtube/channel": { "post": { "operationId": "youtube_channel_v1_data_youtube_channel_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Youtube Channel V1 Data Youtube Channel Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Youtube Channel", "tags": [ "data" ] } }, "/v1/data/youtube/channel-videos": { "post": { "operationId": "youtube_channel_videos_v1_data_youtube_channel_videos_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Youtube Channel Videos V1 Data Youtube Channel Videos Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Youtube Channel Videos", "tags": [ "data" ] } }, "/v1/data/youtube/search": { "post": { "operationId": "youtube_search_v1_data_youtube_search_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Youtube Search V1 Data Youtube Search Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Youtube Search", "tags": [ "data" ] } }, "/v1/data/youtube/video": { "post": { "operationId": "youtube_video_v1_data_youtube_video_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Youtube Video V1 Data Youtube Video Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Youtube Video", "tags": [ "data" ] } }, "/v1/data/{action}:estimate": { "post": { "description": "Pre-run estimate: credits cost before running (PRD §4.2).", "operationId": "estimate_v1_data__action__estimate_post", "parameters": [ { "in": "path", "name": "action", "required": true, "schema": { "title": "Action", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstimateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Estimate V1 Data Action Estimate Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Estimate", "tags": [ "data" ] } }, "/v1/inbox/comments": { "get": { "operationId": "list_comments_v1_inbox_comments_get", "parameters": [ { "in": "query", "name": "account_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, { "in": "query", "name": "platform", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, { "in": "query", "name": "is_hidden", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Hidden" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse_CommentView_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Comments", "tags": [ "inbox" ] } }, "/v1/inbox/comments/{comment_id}/moderate": { "post": { "operationId": "moderate_comment_v1_inbox_comments__comment_id__moderate_post", "parameters": [ { "in": "path", "name": "comment_id", "required": true, "schema": { "title": "Comment Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModerateRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModerateResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Moderate Comment", "tags": [ "inbox" ] } }, "/v1/inbox/comments/{comment_id}/reply": { "post": { "operationId": "reply_comment_v1_inbox_comments__comment_id__reply_post", "parameters": [ { "in": "path", "name": "comment_id", "required": true, "schema": { "title": "Comment Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentView" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Reply Comment", "tags": [ "inbox" ] } }, "/v1/inbox/conversations": { "get": { "operationId": "list_conversations_v1_inbox_conversations_get", "parameters": [ { "in": "query", "name": "account_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, { "in": "query", "name": "platform", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse_ConversationView_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Conversations", "tags": [ "inbox" ] }, "post": { "operationId": "start_conversation_v1_inbox_conversations_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartConversationRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartConversationResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Start Conversation", "tags": [ "inbox" ] } }, "/v1/inbox/conversations/{conversation_id}/messages": { "get": { "operationId": "list_messages_v1_inbox_conversations__conversation_id__messages_get", "parameters": [ { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse_MessageView_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Messages", "tags": [ "inbox" ] }, "post": { "operationId": "send_message_v1_inbox_conversations__conversation_id__messages_post", "parameters": [ { "in": "path", "name": "conversation_id", "required": true, "schema": { "title": "Conversation Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageView" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Send Message", "tags": [ "inbox" ] } }, "/v1/inbox/reviews": { "get": { "operationId": "list_reviews_v1_inbox_reviews_get", "parameters": [ { "in": "query", "name": "account_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id" } }, { "in": "query", "name": "platform", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Platform" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse_ReviewView_" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Reviews", "tags": [ "inbox" ] } }, "/v1/inbox/reviews/{review_id}/reply": { "post": { "operationId": "reply_review_v1_inbox_reviews__review_id__reply_post", "parameters": [ { "in": "path", "name": "review_id", "required": true, "schema": { "title": "Review Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewView" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Reply Review", "tags": [ "inbox" ] } }, "/v1/jobs": { "post": { "description": "Submit an async data job. Returns {job_id, state, request_id}.", "operationId": "submit_job_v1_jobs_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncDataRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Submit Job V1 Jobs Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Submit Job", "tags": [ "jobs" ] } }, "/v1/jobs/b2b-email-callback": { "post": { "description": "Inbound bridge for B2B's webhook-first email endpoints (no auth: the\nupstream calls this URL with no tenant credentials).\n\nCorrelation design: the adapter's email flow (providers/b2b/adapter.py\n``_email_batch``) is a SYNCHRONOUS bounded poll bridge - it mints a uuid\n``refId``, submits a one-item batch pointing at this route, then polls the\nupstream inquiry endpoint. No in-process correlation can exist (the\ncallback lands on a different request/worker), so this route:\n\n1. accepts + logs + stores the raw payload in ``b2b_email_callbacks``\n (durable; keyed by batch_id for a future adapter that consults the\n table instead of polling), and\n2. applies the documented correlation SEAM: any item whose ``refId``\n matches a non-terminal DataJob id completes that job in place\n (result + state) and fires its completion webhook. Today the adapter\n never passes job ids as refIds, so the seam is inert until the adapter\n is taught to - the poll fallback is unaffected either way.\n\nAlways 200 on a parseable body: upstream disables/retry-storms callbacks\nthat 4xx.", "operationId": "b2b_email_callback_v1_jobs_b2b_email_callback_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/B2BEmailCallbackRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response B2B Email Callback V1 Jobs B2B Email Callback Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "B2B Email Callback", "tags": [ "jobs" ] } }, "/v1/jobs/{job_id}": { "get": { "description": "Get job status. Polls the provider if the job is still pending/running.", "operationId": "get_job_v1_jobs__job_id__get", "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "title": "Job Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Get Job V1 Jobs Job Id Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Job", "tags": [ "jobs" ] } }, "/v1/media": { "post": { "description": "Fetch + validate + rehost one URL. SSRF violations reject with 400;\nfetch/validation failures return the asset with status ``failed``.", "operationId": "ingest_media_v1_media_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestMediaRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Ingest Media", "tags": [ "media" ] } }, "/v1/media/{asset_id}": { "get": { "operationId": "get_media_v1_media__asset_id__get", "parameters": [ { "in": "path", "name": "asset_id", "required": true, "schema": { "title": "Asset Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaAssetResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Media", "tags": [ "media" ] } }, "/v1/meta/actions": { "get": { "description": "Catalog of every data action: routing chain, tenant price, delta support.\n\n``enabled_for_you`` reflects the caller's plan/customer entitlements so\nclients can grey out gated endpoints instead of discovering the 403.", "operationId": "list_actions_v1_meta_actions_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Actions V1 Meta Actions Get", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Actions", "tags": [ "meta" ] } }, "/v1/meta/hit-rates": { "get": { "description": "Aggregated per-action hit rates from ``data_call_events``.\n\nTenant scope is the caller's own rows only. Global scope aggregates across\nall tenants with k-anonymity guards (min 30 calls, counts floored to 10).\nAn action with no calls in the window simply does not appear — the empty\nstate is an empty ``actions`` list, never fabricated numbers.", "operationId": "hit_rates_v1_meta_hit_rates_get", "parameters": [ { "in": "query", "name": "window_days", "required": false, "schema": { "default": 7, "maximum": 90, "minimum": 1, "title": "Window Days", "type": "integer" } }, { "in": "query", "name": "scope", "required": false, "schema": { "default": "tenant", "title": "Scope", "type": "string" } }, { "in": "query", "name": "action", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Hit Rates V1 Meta Hit Rates Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Hit Rates", "tags": [ "meta" ] } }, "/v1/posts": { "get": { "operationId": "list_posts_v1_posts_get", "parameters": [ { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "profile_id", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Profile Id" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PostResponse" }, "title": "Response List Posts V1 Posts Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Posts", "tags": [ "posts" ] }, "post": { "operationId": "create_post_v1_posts_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePostRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Post", "tags": [ "posts" ] } }, "/v1/posts/{post_id}": { "delete": { "description": "Cancel scheduled work / delete published targets remotely where allowed.", "operationId": "cancel_post_v1_posts__post_id__delete", "parameters": [ { "in": "path", "name": "post_id", "required": true, "schema": { "title": "Post Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Cancel Post", "tags": [ "posts" ] }, "get": { "operationId": "get_post_v1_posts__post_id__get", "parameters": [ { "in": "path", "name": "post_id", "required": true, "schema": { "title": "Post Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Post", "tags": [ "posts" ] } }, "/v1/posts/{post_id}/retry": { "post": { "description": "Re-queue failed_retryable targets only.", "operationId": "retry_post_v1_posts__post_id__retry_post", "parameters": [ { "in": "path", "name": "post_id", "required": true, "schema": { "title": "Post Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Retry Post", "tags": [ "posts" ] } }, "/v1/profiles": { "get": { "operationId": "list_profiles_v1_profiles_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ProfileResponse" }, "title": "Response List Profiles V1 Profiles Get", "type": "array" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Profiles", "tags": [ "profiles" ] }, "post": { "operationId": "create_profile_v1_profiles_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Profile", "tags": [ "profiles" ] } }, "/v1/profiles/{profile_id}": { "delete": { "operationId": "delete_profile_v1_profiles__profile_id__delete", "parameters": [ { "in": "path", "name": "profile_id", "required": true, "schema": { "title": "Profile Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Profile", "tags": [ "profiles" ] }, "get": { "operationId": "get_profile_v1_profiles__profile_id__get", "parameters": [ { "in": "path", "name": "profile_id", "required": true, "schema": { "title": "Profile Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Profile", "tags": [ "profiles" ] }, "put": { "operationId": "update_profile_v1_profiles__profile_id__put", "parameters": [ { "in": "path", "name": "profile_id", "required": true, "schema": { "title": "Profile Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfileResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Update Profile", "tags": [ "profiles" ] } }, "/v1/rates/eibor/history": { "get": { "description": "EIBOR fixing history, oldest first. ``tenor`` narrows to one curve point.", "operationId": "eibor_history_v1_rates_eibor_history_get", "parameters": [ { "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From" } }, { "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, { "description": "on|1w|1m|3m|6m|1y", "in": "query", "name": "tenor", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "on|1w|1m|3m|6m|1y", "title": "Tenor" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 90, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Eibor History V1 Rates Eibor History Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Eibor History", "tags": [ "rates" ] } }, "/v1/rates/eibor/latest": { "get": { "description": "Latest EIBOR fixing across all tenors (O/N, 1W, 1M, 3M, 6M, 1Y).\n\n``value_date`` is the T+2 spot date the fixing settles to — mortgage and\ntreasury models need it alongside the rate.", "operationId": "eibor_latest_v1_rates_eibor_latest_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Eibor Latest V1 Rates Eibor Latest Get", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Eibor Latest", "tags": [ "rates" ] } }, "/v1/rates/fuel/history": { "get": { "description": "Monthly fuel-price history, oldest first.", "operationId": "fuel_history_v1_rates_fuel_history_get", "parameters": [ { "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From" } }, { "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, { "description": "super98|special95|eplus91|diesel", "in": "query", "name": "fuel_type", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "super98|special95|eplus91|diesel", "title": "Fuel Type" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 120, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Fuel History V1 Rates Fuel History Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Fuel History", "tags": [ "rates" ] } }, "/v1/rates/fuel/latest": { "get": { "description": "Current UAE fuel-committee prices (AED per litre).\n\nThe committee sets one nationwide price per grade each month. A month\ncaptured from an unlabeled source during the rollover window is flagged\n``provisional`` until a differing page confirms the flip (MI-154).", "operationId": "fuel_latest_v1_rates_fuel_latest_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Fuel Latest V1 Rates Fuel Latest Get", "type": "object" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Fuel Latest", "tags": [ "rates" ] } }, "/v1/rates/fx/convert": { "get": { "description": "Convert an amount at CBUAE official rates, crossing via AED.\n\nDefaults to today's Gulf-calendar date, which resolves to the most recent\npublication — so an invoice cut on a weekend still converts correctly.", "operationId": "fx_convert_v1_rates_fx_convert_get", "parameters": [ { "in": "query", "name": "amount", "required": true, "schema": { "exclusiveMinimum": 0, "title": "Amount", "type": "number" } }, { "description": "ISO 4217 or AED", "in": "query", "name": "from", "required": true, "schema": { "description": "ISO 4217 or AED", "title": "From", "type": "string" } }, { "description": "ISO 4217 or AED", "in": "query", "name": "to", "required": true, "schema": { "description": "ISO 4217 or AED", "title": "To", "type": "string" } }, { "description": "YYYY-MM-DD", "in": "query", "name": "date", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "YYYY-MM-DD", "title": "Date" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Fx Convert V1 Rates Fx Convert Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Fx Convert", "tags": [ "rates" ] } }, "/v1/rates/fx/history": { "get": { "description": "Published-rate history, oldest first. ``currency`` narrows to one code.", "operationId": "fx_history_v1_rates_fx_history_get", "parameters": [ { "description": "ISO 4217 code", "in": "query", "name": "currency", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO 4217 code", "title": "Currency" } }, { "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From" } }, { "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 90, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Fx History V1 Rates Fx History Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Fx History", "tags": [ "rates" ] } }, "/v1/rates/fx/latest": { "get": { "description": "Latest CBUAE official rates — AED per one unit of each currency.\n\nThese are the rates the FTA accepts for VAT on foreign-currency invoices;\nuse ``/fx/on-date`` when you need the rate for a specific invoice date.", "operationId": "fx_latest_v1_rates_fx_latest_get", "parameters": [ { "description": "ISO 4217 code, e.g. USD", "in": "query", "name": "currency", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO 4217 code, e.g. USD", "title": "Currency" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Fx Latest V1 Rates Fx Latest Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Fx Latest", "tags": [ "rates" ] } }, "/v1/rates/fx/on-date": { "get": { "description": "The official rate to use for an invoice dated ``date`` (FTA/VAT).\n\nCBUAE publishes on business days only, so a weekend or holiday invoice\ndate resolves to the most recent prior publication — the same rule\nauditors apply. ``published_on`` tells you which publication was used.", "operationId": "fx_on_date_v1_rates_fx_on_date_get", "parameters": [ { "description": "ISO 4217 code, e.g. USD", "in": "query", "name": "currency", "required": true, "schema": { "description": "ISO 4217 code, e.g. USD", "title": "Currency", "type": "string" } }, { "description": "Invoice date, YYYY-MM-DD", "in": "query", "name": "date", "required": true, "schema": { "description": "Invoice date, YYYY-MM-DD", "title": "Date", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Fx On Date V1 Rates Fx On Date Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Fx On Date", "tags": [ "rates" ] } }, "/v1/rates/gold/convert": { "get": { "description": "Price ``amount`` of gold at the latest retail rate for ``karat``.", "operationId": "gold_convert_v1_rates_gold_convert_get", "parameters": [ { "description": "Weight of gold to price", "in": "query", "name": "amount", "required": true, "schema": { "description": "Weight of gold to price", "exclusiveMinimum": 0, "title": "Amount", "type": "number" } }, { "description": "24 | 22 | 21 | 18", "in": "query", "name": "karat", "required": false, "schema": { "default": 22, "description": "24 | 22 | 21 | 18", "title": "Karat", "type": "integer" } }, { "description": "gram | tola | ounce", "in": "query", "name": "unit", "required": false, "schema": { "default": "gram", "description": "gram | tola | ounce", "title": "Unit", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Gold Convert V1 Rates Gold Convert Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Gold Convert", "tags": [ "rates" ] } }, "/v1/rates/gold/history": { "get": { "description": "Historical gold rates, oldest first. ``karat`` narrows to one purity.", "operationId": "gold_history_v1_rates_gold_history_get", "parameters": [ { "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "From" } }, { "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "To" } }, { "description": "24 | 22 | 21 | 18", "in": "query", "name": "karat", "required": false, "schema": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "description": "24 | 22 | 21 | 18", "title": "Karat" } }, { "description": "gram | tola | ounce", "in": "query", "name": "unit", "required": false, "schema": { "default": "gram", "description": "gram | tola | ounce", "title": "Unit", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "maximum": 500, "minimum": 1, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Gold History V1 Rates Gold History Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Gold History", "tags": [ "rates" ] } }, "/v1/rates/gold/latest": { "get": { "description": "Latest Dubai retail gold rates (24K/22K/21K/18K) in AED and USD.\n\nThese are the jewellery-souk retail rates consumers and jewellery apps\nquote, not the global spot price. ``source`` says whether the rate came\nfrom the published Dubai Jewellery Group table or the calibrated\nspot-derived fallback.", "operationId": "gold_latest_v1_rates_gold_latest_get", "parameters": [ { "description": "gram | tola | ounce", "in": "query", "name": "unit", "required": false, "schema": { "default": "gram", "description": "gram | tola | ounce", "title": "Unit", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Gold Latest V1 Rates Gold Latest Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Gold Latest", "tags": [ "rates" ] } }, "/v1/webhooks": { "get": { "operationId": "list_endpoints_v1_webhooks_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/WebhookEndpointResponse" }, "title": "Response List Endpoints V1 Webhooks Get", "type": "array" } } }, "description": "Successful Response" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Endpoints", "tags": [ "webhooks" ] }, "post": { "operationId": "create_endpoint_v1_webhooks_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreatedResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Endpoint", "tags": [ "webhooks" ] } }, "/v1/webhooks/deliveries/{delivery_id}/redrive": { "post": { "description": "DLQ replay: reset a DEAD delivery to pending with a fresh retry cycle.", "operationId": "redrive_v1_webhooks_deliveries__delivery_id__redrive_post", "parameters": [ { "in": "path", "name": "delivery_id", "required": true, "schema": { "title": "Delivery Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeliveryResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Redrive", "tags": [ "webhooks" ] } }, "/v1/webhooks/{endpoint_id}": { "delete": { "operationId": "delete_endpoint_v1_webhooks__endpoint_id__delete", "parameters": [ { "in": "path", "name": "endpoint_id", "required": true, "schema": { "title": "Endpoint Id", "type": "string" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Delete Endpoint", "tags": [ "webhooks" ] }, "get": { "operationId": "get_endpoint_v1_webhooks__endpoint_id__get", "parameters": [ { "in": "path", "name": "endpoint_id", "required": true, "schema": { "title": "Endpoint Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Get Endpoint", "tags": [ "webhooks" ] }, "put": { "operationId": "update_endpoint_v1_webhooks__endpoint_id__put", "parameters": [ { "in": "path", "name": "endpoint_id", "required": true, "schema": { "title": "Endpoint Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Update Endpoint", "tags": [ "webhooks" ] } }, "/v1/webhooks/{endpoint_id}/deliveries": { "get": { "operationId": "list_deliveries_v1_webhooks__endpoint_id__deliveries_get", "parameters": [ { "in": "path", "name": "endpoint_id", "required": true, "schema": { "title": "Endpoint Id", "type": "string" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 100, "title": "Limit", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/DeliveryResponse" }, "title": "Response List Deliveries V1 Webhooks Endpoint Id Deliveries Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Deliveries", "tags": [ "webhooks" ] } }, "/v1/webhooks/{endpoint_id}/rotate": { "post": { "description": "Mint a new signing secret; the old one keeps verifying (and dual-signs\nas ``v2=``) until ``previous_secret_expires_at``.", "operationId": "rotate_secret_v1_webhooks__endpoint_id__rotate_post", "parameters": [ { "in": "path", "name": "endpoint_id", "required": true, "schema": { "title": "Endpoint Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotatedSecretResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Rotate Secret", "tags": [ "webhooks" ] } }, "/v1/webhooks/{endpoint_id}/test": { "post": { "description": "Create a ``webhook.test`` delivery and attempt it inline. A failed\nattempt stays pending and retries on the normal backoff schedule.", "operationId": "test_fire_v1_webhooks__endpoint_id__test_post", "parameters": [ { "in": "path", "name": "endpoint_id", "required": true, "schema": { "title": "Endpoint Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestFireResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Test Fire", "tags": [ "webhooks" ] } }, "/v1/whatsapp/accounts/{account_id}/register": { "post": { "description": "Register the account's active phone number for the Cloud API with the\nuser-supplied PIN (explicit - never implicit in entity activation).", "operationId": "register_number_v1_whatsapp_accounts__account_id__register_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterNumberRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterNumberResponse" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Register Number", "tags": [ "whatsapp" ] } }, "/v1/whatsapp/accounts/{account_id}/templates": { "get": { "description": "List templates from the WABA and sync their status/category into\n``wa_templates`` (pull-based refresh of the send-path gate's source).", "operationId": "list_templates_v1_whatsapp_accounts__account_id__templates_get", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/TemplateView" }, "title": "Response List Templates V1 Whatsapp Accounts Account Id Templates Get", "type": "array" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "List Templates", "tags": [ "whatsapp" ] }, "post": { "description": "Create a template and persist its PENDING row; the status resolves later\nvia the ``message_template_status_update`` webhook or a subsequent list.", "operationId": "create_template_v1_whatsapp_accounts__account_id__templates_post", "parameters": [ { "in": "path", "name": "account_id", "required": true, "schema": { "title": "Account Id", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateView" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "security": [ { "HTTPBearer": [] } ], "summary": "Create Template", "tags": [ "whatsapp" ] } } }, "servers": [ { "url": "https://api.qannasapi.com" } ] }