{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:retell-ai/call-establish-connection":{"post":{"operationId":"communication_retell_ai_call_establish_connection","summary":"Register Call To Get CallId To Establish Connection","description":"POST /register-call","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/call-get-details":{"get":{"operationId":"communication_retell_ai_call_get_details","summary":"Retrieve details of a specific call","description":"GET /get-call/{call_id}","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"call_id","in":"query","required":true,"description":"The call id to retrieve call history for.","schema":{"type":"string","description":"The call id to retrieve call history for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/call-get-details-2":{"get":{"operationId":"communication_retell_ai_call_get_details_2","summary":"Retrieve call details","description":"GET /list-calls","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"filter_criteria","in":"query","required":false,"schema":{"type":"object"}},{"name":"sort_order","in":"query","required":false,"description":"The calls will be sorted by `start_timestamp`, whether to return the calls in ascending or descending order.","schema":{"type":"string","enum":["ascending","descending"],"default":"descending","description":"The calls will be sorted by `start_timestamp`, whether to return the calls in ascending or descending order."}},{"name":"limit","in":"query","required":false,"description":"Limit the number of calls returned.","schema":{"type":"integer","default":1000,"description":"Limit the number of calls returned."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/agent-create-new-agent":{"post":{"operationId":"communication_retell_ai_agent_create_new_agent","summary":"Create a new agent","description":"POST /create-agent","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/agent-get-details":{"get":{"operationId":"communication_retell_ai_agent_get_details","summary":"Retrieve details of a specific agent","description":"GET /get-agent/{agent_id}","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"agent_id","in":"query","required":true,"description":"Unique id of the agent to be retrieved.","schema":{"type":"string","description":"Unique id of the agent to be retrieved."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/agent-get-all":{"get":{"operationId":"communication_retell_ai_agent_get_all","summary":"List all agents","description":"GET /list-agents","tags":["communication"],"x-apizie-access":"read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/agent-update-existing-agent":{"post":{"operationId":"communication_retell_ai_agent_update_existing_agent","summary":"Update an existing agent","description":"PATCH /update-agent/{agent_id}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agent_id","body"],"properties":{"agent_id":{"type":"string","description":"Unique id of the agent to be updated."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/agent-delete-existing-agent":{"post":{"operationId":"communication_retell_ai_agent_delete_existing_agent","summary":"Delete an existing agent","description":"DELETE /delete-agent/{agent_id}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agent_id"],"properties":{"agent_id":{"type":"string","description":"Unique id of the agent to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/retell-new-llm":{"post":{"operationId":"communication_retell_ai_retell_new_llm","summary":"Create a new Retell LLM","description":"POST /create-retell-llm","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/retell-get-llm-details":{"get":{"operationId":"communication_retell_ai_retell_get_llm_details","summary":"Retrieve details of a specific Retell LLM","description":"GET /get-retell-llm/{llm_id}","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"llm_id","in":"query","required":true,"description":"Unique id of the Retell LLM to be retrieved.","schema":{"type":"string","description":"Unique id of the Retell LLM to be retrieved."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/retell-llm-list-all":{"get":{"operationId":"communication_retell_ai_retell_llm_list_all","summary":"List all retell LLM","description":"GET /list-retell-llms","tags":["communication"],"x-apizie-access":"read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/retell-update-llm":{"post":{"operationId":"communication_retell_ai_retell_update_llm","summary":"Update an existing Retell LLM","description":"PATCH /update-retell-llm/{llm_id}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["llm_id","body"],"properties":{"llm_id":{"type":"string","description":"Unique id of the Retell LLM to be updated."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/retell-delete-llm":{"post":{"operationId":"communication_retell_ai_retell_delete_llm","summary":"Delete an existing Retell LLM","description":"DELETE /delete-retell-llm/{llm_id}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["llm_id"],"properties":{"llm_id":{"type":"string","description":"Unique id of the Retell LLM to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/phone-number-purchase-number-and-bind-agent":{"post":{"operationId":"communication_retell_ai_phone_number_purchase_number_and_bind_agent","summary":"Buy a new phone number & Bind an agent","description":"POST /create-phone-number","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/phone-number-get-details":{"get":{"operationId":"communication_retell_ai_phone_number_get_details","summary":"Retrieve details of a specific phone number","description":"GET /get-phone-number/{phone_number}","tags":["communication"],"x-apizie-access":"read","parameters":[{"name":"phone_number","in":"query","required":true,"description":"BCP 47 format of the number (+country code, then number with no space, no special characters), used as the unique identifier for phone…","schema":{"type":"string","description":"BCP 47 format of the number (+country code, then number with no space, no special characters), used as the unique identifier for phone…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/phone-number-get-all-numbers":{"get":{"operationId":"communication_retell_ai_phone_number_get_all_numbers","summary":"List all phone numbers","description":"GET /list-phone-numbers","tags":["communication"],"x-apizie-access":"read","parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/phone-number-update-retell-llm":{"post":{"operationId":"communication_retell_ai_phone_number_update_retell_llm","summary":"Update an existing Retell LLM","description":"PATCH /update-phone-number/{phone_number}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phone_number","body"],"properties":{"phone_number":{"type":"string","description":"BCP 47 format of the number (+country code, then number with no space, no special characters), used as the unique identifier for phone…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/phone-number-remove-phone-number":{"post":{"operationId":"communication_retell_ai_phone_number_remove_phone_number","summary":"Delete an existing phone number","description":"DELETE /delete-phone-number/{phone_number}","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["phone_number"],"properties":{"phone_number":{"type":"string","description":"BCP 47 format of the number (+country code, then number with no space, no special characters), used as the unique identifier for phone…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:retell-ai/call-make-connection":{"post":{"operationId":"communication_retell_ai_call_make_connection","summary":"Create a new phone call","description":"POST /create-phone-call","tags":["communication"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}