{"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/cloud:tencent-dataagent/add-chunk":{"post":{"operationId":"cloud_tencent_dataagent_add_chunk","summary":"Add Chunk","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","FileId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"FileId":{"type":"string"},"BeforeChunkId":{"type":"string"},"InsertPos":{"type":"integer"},"Content":{"type":"string"},"AfterChunkId":{"type":"string"},"KnowledgeBaseId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/append-knowledge-task":{"post":{"operationId":"cloud_tencent_dataagent_append_knowledge_task","summary":"Append Knowledge Task","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"KnowledgeBaseId":{"type":"string"},"FileId":{"type":"string"},"Documents":{"type":"array"}}}}}},"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/cloud:tencent-dataagent/chat-ai":{"post":{"operationId":"cloud_tencent_dataagent_chat_ai","summary":"Chat AI","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SessionId":{"type":"string"},"InstanceId":{"type":"string"},"Question":{"type":"string"},"Context":{"type":"string"},"Model":{"type":"string"},"DeepThinking":{"type":"boolean"},"DataSourceIds":{"type":"array"},"AgentType":{"type":"string"},"OldRecordId":{"type":"string"},"KnowledgeBaseIds":{"type":"array"},"ArchVersion":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/create-data-agent-session":{"post":{"operationId":"cloud_tencent_dataagent_create_data_agent_session","summary":"Create Data Agent Session","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/delete-chunk":{"post":{"operationId":"cloud_tencent_dataagent_delete_chunk","summary":"Delete Chunk","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","FileId","ChunkIds"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"FileId":{"type":"string"},"ChunkIds":{"type":"array"},"KnowledgeBaseId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/delete-data-agent-session":{"post":{"operationId":"cloud_tencent_dataagent_delete_data_agent_session","summary":"Delete Data Agent Session","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"SessionId":{"type":"string"},"SessionIds":{"type":"array"}}}}}},"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/cloud:tencent-dataagent/execute-agent-api":{"post":{"operationId":"cloud_tencent_dataagent_execute_agent_api","summary":"Execute Agent Api","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"RequestPath":{"type":"string"},"RequestData":{"type":"string"},"RequestType":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/execute-agent-api-v1":{"post":{"operationId":"cloud_tencent_dataagent_execute_agent_api_v1","summary":"Execute Agent Api V1","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"RequestPath":{"type":"string"},"RequestType":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/get-jobs-by-knowledge-base-id":{"post":{"operationId":"cloud_tencent_dataagent_get_jobs_by_knowledge_base_id","summary":"Get Jobs By Knowledge Base Id","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"KnowledgeBaseId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/get-knowledge-base-file-list":{"post":{"operationId":"cloud_tencent_dataagent_get_knowledge_base_file_list","summary":"Get Knowledge Base File List","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"Page":{"type":"integer"},"PageSize":{"type":"integer"},"KnowledgeBaseId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/get-knowledge-base-list":{"post":{"operationId":"cloud_tencent_dataagent_get_knowledge_base_list","summary":"Get Knowledge Base List","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/get-upload-job-details":{"post":{"operationId":"cloud_tencent_dataagent_get_upload_job_details","summary":"Get Upload Job Details","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"JobId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/get-user-instance-list":{"post":{"operationId":"cloud_tencent_dataagent_get_user_instance_list","summary":"Get User Instance List","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"}}}}}},"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/cloud:tencent-dataagent/modify-chunk":{"post":{"operationId":"cloud_tencent_dataagent_modify_chunk","summary":"Modify Chunk","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","FileId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"FileId":{"type":"string"},"ChunkId":{"type":"string"},"Content":{"type":"string"},"Summary":{"type":"string"},"KnowledgeBaseId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/modify-knowledge-base":{"post":{"operationId":"cloud_tencent_dataagent_modify_knowledge_base","summary":"Modify Knowledge Base","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","OperateType"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"OperateType":{"type":"string"},"KnowledgeBaseId":{"type":"string"},"KnowledgeBaseName":{"type":"string"},"KnowledgeBaseDesc":{"type":"string"},"UseScope":{"type":"integer"},"AuthorityUins":{"type":"array"},"Config":{"type":"object"}}}}}},"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/cloud:tencent-dataagent/modify-user-authority":{"post":{"operationId":"cloud_tencent_dataagent_modify_user_authority","summary":"Modify User Authority","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","Module","ObjectId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"Module":{"type":"string"},"ObjectId":{"type":"string"},"UseScope":{"type":"integer"},"AuthorityUins":{"type":"array"}}}}}},"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/cloud:tencent-dataagent/query-chunk-list":{"post":{"operationId":"cloud_tencent_dataagent_query_chunk_list","summary":"Query Chunk List","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"Page":{"type":"integer"},"PageSize":{"type":"integer"},"KnowledgeBaseId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/query-knowledge-task":{"post":{"operationId":"cloud_tencent_dataagent_query_knowledge_task","summary":"Query Knowledge Task","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"KnowledgeBaseId":{"type":"string"},"FileIds":{"type":"array"}}}}}},"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/cloud:tencent-dataagent/query-models":{"post":{"operationId":"cloud_tencent_dataagent_query_models","summary":"Query Models","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/query-user-authority":{"post":{"operationId":"cloud_tencent_dataagent_query_user_authority","summary":"Query User Authority","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId","Module","ObjectId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"Module":{"type":"string"},"ObjectId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/query-user-session-detail":{"post":{"operationId":"cloud_tencent_dataagent_query_user_session_detail","summary":"Query User Session Detail","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SessionId":{"type":"string"},"Limit":{"type":"integer"},"Offset":{"type":"integer"},"InstanceId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/stop-chat-ai":{"post":{"operationId":"cloud_tencent_dataagent_stop_chat_ai","summary":"Stop Chat AI","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"SessionId":{"type":"string"},"InstanceId":{"type":"string"}}}}}},"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/cloud:tencent-dataagent/upload-and-commit-file":{"post":{"operationId":"cloud_tencent_dataagent_upload_and_commit_file","summary":"Upload And Commit File","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"InstanceId":{"type":"string"},"CosFiles":{"type":"array"},"KnowledgeBaseId":{"type":"string"}}}}}},"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"}}}}}}}