{"openapi":"3.1.0","info":{"title":"Attentive (BYOK) API","version":"0.1.0","description":"Attentive (BYOK) lets an AI assistant read your own Attentive data through the Attentive API with a key you supply (Attentive private app API key). Read-only: 8 tools (get_me, list_segments, get_segment, get_clear_segment_status, list_webhooks, list_catalog_uploads, get_catalog_upload, get_bulk_job_status). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-attentive.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-attentive/docs"},"termsOfService":"https://connectorbay.com/byok-attentive/terms"},"servers":[{"url":"https://byok-attentive.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-attentive/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_me":{"post":{"operationId":"get_me","summary":"Show the company and application the API key belongs to: application name, Attentive domain, company name, company ID an","description":"Show the company and application the API key belongs to: application name, Attentive domain, company name, company ID and contact email. Use for \"Which Attentive company is my API key connected to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_meArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_segments":{"post":{"operationId":"list_segments","summary":"List audience segments with name, description, external ID and created and updated times; filter by name, external ID or","description":"List audience segments with name, description, external ID and created and updated times; filter by name, external ID or last update. Needs the segments read scope. Use for \"What audience segments do I have in Attentive\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Segments whose name contains this text.","title":"Name"},"external_id":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only the segment with this external ID.","title":"External Id"},"updated_since":{"anyOf":[{"maxLength":40,"type":"string"},{"type":"null"}],"default":null,"description":"Only segments updated since this ISO 8601 time, for example 2026-10-01T00:00:00Z.","title":"Updated Since"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Pagination cursor from the previous answer.","title":"Cursor"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":20,"description":"How many results to return (1 to 1000).","title":"Limit"}},"title":"list_segmentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_segment":{"post":{"operationId":"get_segment","summary":"Get one audience segment by its external ID. Use for \"Show the details of the segment with external ID vip-customers\".","description":"Get one audience segment by its external ID. Use for \"Show the details of the segment with external ID vip-customers\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"external_id":{"description":"External ID of the segment.","maxLength":200,"title":"External Id","type":"string"}},"required":["external_id"],"title":"get_segmentArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_clear_segment_status":{"post":{"operationId":"get_clear_segment_status","summary":"Get the status of the most recent clear-all-members operation on a segment: status, start and completion time and failur","description":"Get the status of the most recent clear-all-members operation on a segment: status, start and completion time and failure reason. Use for \"Did the clearing of segment vip-customers finish\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"external_id":{"description":"External ID of the segment.","maxLength":200,"title":"External Id","type":"string"}},"required":["external_id"],"title":"get_clear_segment_statusArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_webhooks":{"post":{"operationId":"list_webhooks","summary":"List the webhooks registered for the company with target URL, type, subscribed events and disabled time. Use for \"Which ","description":"List the webhooks registered for the company with target URL, type, subscribed events and disabled time. Use for \"Which Attentive webhooks are registered\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_webhooksArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_catalog_uploads":{"post":{"operationId":"list_catalog_uploads","summary":"List recent product catalog uploads with status, counts of products received and processed, errors and last update time.","description":"List recent product catalog uploads with status, counts of products received and processed, errors and last update time. Use for \"How did my last Attentive product catalog uploads go\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_catalog_uploadsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_catalog_upload":{"post":{"operationId":"get_catalog_upload","summary":"Get the ingestion status of one product catalog upload by its upload ID, including line-level errors. Use for \"What is t","description":"Get the ingestion status of one product catalog upload by its upload ID, including line-level errors. Use for \"What is the status of catalog upload abc-123\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"upload_id":{"description":"Upload ID returned when the catalog was uploaded.","maxLength":200,"title":"Upload Id","type":"string"}},"required":["upload_id"],"title":"get_catalog_uploadArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_bulk_job_status":{"post":{"operationId":"get_bulk_job_status","summary":"Get the status of a bulk ingestion job: status, total records and result URL. Use for \"Did bulk job job-123 finish\".","description":"Get the status of a bulk ingestion job: status, total records and result URL. Use for \"Did bulk job job-123 finish\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"bulk_job_id":{"description":"ID of the bulk job.","maxLength":200,"title":"Bulk Job Id","type":"string"}},"required":["bulk_job_id"],"title":"get_bulk_job_statusArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}