{"openapi":"3.0.0","servers":[{"url":"https://apipie.ai","description":"Default server"}],"info":{"description":"\n APIPie.ai is the unified API for building and scaling agentic AI workflows.  \n\nAccess models, internet search, vector search, document parsing powered by Apache Tika, and pseudonymization powered by Presidio through a single platform designed for automation.  \n\nIngest, structure, and secure company data to power RAG pipelines, autonomous agents, and end-to-end business workflows without stitching together fragmented tools.  \n\nEnrich your systems with external data sources for search, market intelligence, and competitive analysis, all accessible on demand.  \n\nAPIPie.ai is fully usage-based—pay only for what you use, with no upfront cost or wasted infrastructure.\n\nUsing APIpie requires the use of an API key, [click here to create an API key and get started](https://apipie.ai/profile/api-keys).\n","version":"1.0.0","title":"Introduction","termsOfService":"https://apipie.ai/docs/terms/api-agree","contact":{"name":"APIpie Support","email":"support@neuronic.ai","url":"https://discord.gg/Xky8bqP2CF"}},"tags":[{"name":"Chat","description":"Our Chat API schema for chat completions and instruct models are both accessible behind the chat completions interface which is inline with [OpenAi Chat API](https://platform.openai.com/docs/api-reference/chat/create) with added usage data in the response, \n\n Change the domain name and API Key from your current Open AI implementation to start using APIpie.ai!","displayName":"Chat Completions and Instructs"},{"name":"Audio","description":"Our Audio API schema for Text To Speech, Speech to Text and general AI Audio API is inline with [OpenAi Chat API](https://platform.openai.com/docs/api-reference/chat/create) with added usage data in the response, \n\n Change the domain name and API Key from your current Open AI implementation to start using APIpie.ai!","displayName":"Audio TTS & STT"},{"name":"Models","description":"Our Models API schema provides very extended and comprehensive model data far beyond OpenAI’s models route, providing extended model details and performance data","displayName":"Models"},{"name":"Embeddings","description":"Our Embeddings API schema is inline with [OpenAi Embeddings API](https://platform.openai.com/docs/api-reference/embeddings) with added usage data in the response, \n\n Change the domain name and API Key from your current Open AI implementation to start using APIpie.ai!","displayName":"Embeddings"},{"name":"Images","description":"Our Image generations API schema is inline with [OpenAi Image generation API](https://platform.openai.com/docs/api-reference/embeddings) with added usage data in the response, \n\n Change the domain name and API Key from your current Open AI implementation to start using APIpie.ai!","displayName":"Images"},{"name":"Urlshare","description":"Endpoint to convert file to temp url when you need to pass an image url instead of an image","displayName":"Urlshare"},{"name":"Ragtune","description":"Used to augment knowledge base of any language model directly in the chat completions route. Simply upload documents to a collection and then use that collection name in your query, it couldnt be easier.","displayName":"Ragtune"},{"name":"Vectors","description":"qDrant and Pinecone through a mostly native Pinecone API support using the /vectors route and some minor differences for index nomenclature to support scalability","displayName":"Vectors"},{"name":"Search","description":"Ground your AI query with search and content acquisition functions, additionally search proprietary data sources through Valyu.ai search","displayName":"Search"},{"name":"Data","description":"Access to external data APIs including job search and real estate data, with additional data for amazon, walmart, uber and doordash available on request, for powerful ai power market forensics workflows.","displayName":"Data APIs"},{"name":"Parser","description":"Parse and extract structured content from documents using Apache Tika. Supports a wide range of file formats for ingestion into RAG pipelines, search systems, and downstream AI workflows.","displayName":"Document Parsing"},{"name":"Anon","description":"Pseudonymize and protect sensitive data using Presidio-powered anonymization. Detect and redact PII from text before processing, storage, or model interaction.","displayName":"Pseudonymization"},{"name":"State","description":"Manage API key-based configuration state. Predefine reusable configurations that control parameters, models, and behavior across requests, enabling consistent and automated agent workflow capability even when the tools themselves dont support it.","displayName":"State Management"},{"name":"InlineCli","description":"Just send `:help` in the first part of the user prompt with API or a chat client using our api to get a help menu. Enable your agentic AI to control the API options and features through the prompt itself. Make any workflow agent more powerful with the APIpie Inline-CLI. Control models, search, memory, shaping, hallucination protection and more — all without extra API calls and empowering your AI Agent to take its ability to the next level through the prompt itself. Only at APIpie.ai","displayName":"Inline CLI"}],"tagGroups":[{"name":"Vectorsets","description":"Operations related to vector collections and vectors within collections","displayName":"Vectorsets"},{"name":"Chat","tags":["Chat","InlineCli"]},{"name":"Audio","tags":["Audio"]},{"name":"Models","tags":["Models"]},{"name":"Embeddings","tags":["Embeddings"]},{"name":"Images","tags":["Images"]},{"name":"Urlshare","tags":["Urlshare"]},{"name":"Ragtune","tags":["Ragtune"]},{"name":"Vectors","tags":["Vectors"]},{"name":"Search","tags":["Search"]},{"name":"Data","tags":["Data"]},{"name":"Parser","tags":["Parser"]},{"name":"Anon","tags":["Anon"]},{"name":"State","tags":["State"]}],"components":{"securitySchemes":{"apikey":{"type":"apiKey","in":"header","name":"Authorization"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"use authentication bearer or x-api-key and API Key header with your API key"},"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"use x-api-key or authentication bearer and API Key header with your API key"}},"schemas":{"AnonRequest":{"type":"object","additionalProperties":false,"description":"Request body for text anonymization","properties":{"text":{"type":"string","minLength":1,"description":"Text containing potentially sensitive information to be anonymized","example":"John Doe lives in Seattle and his phone number is 555-123-4567"}},"required":["text"]},"AnonMapping":{"type":"object","description":"Mapping between original value and anonymized replacement","properties":{"actual_value":{"type":"string","description":"Original sensitive value detected in the text","example":"John Doe"},"mapped_value":{"type":"string","description":"Truncated SHA-256 hash (16 characters) replacing the original value","example":"f241fffc3e5e67ab9"},"type":{"type":"string","description":"Type of PII entity detected by Presidio analyzer","example":"PERSON"}}},"AnonResponse":{"type":"object","description":"Response containing anonymized text and value mappings","properties":{"anon_text":{"type":"string","description":"Text with all detected PII replaced by truncated SHA-256 hashes","example":"6cea57c2fb6cbc2a lives in 52235717290f5d20 and his phone number is d36e83082288d9f2"},"mappings":{"type":"array","description":"Array of mappings between original values and their anonymized replacements","items":{"$ref":"#/components/schemas/AnonMapping"}}}},"AudioSpeechRequest":{"type":"object","required":["provider","model","input","voice"],"properties":{"provider":{"type":"string","description":"Name of the audio provider, default to 'openai'.","example":"elevenlabs"},"model":{"type":"string","description":"Model identifier for the speech synthesis.","example":"eleven_multilingual_v2"},"input":{"type":"string","description":"Text input to be converted into speech.","example":"why is the sky blue?"},"voice":{"type":"string","description":"Voice setting for the speech synthesis. Query /v1/models?voices for complete list.","example":"2EiwWnXFnvU5JabPnv8n"},"voiceSettings":{"type":"object","description":"Additional settings for voice modulation.","properties":{"stability":{"type":"integer","description":"Stability of the voice modulation, 0-1.","example":0.42,"minimum":0,"maximum":1},"similarity_boost":{"type":"integer","description":"Boost the similarity of the voice modulation, 0-1.","example":0.68,"minimum":0,"maximum":1},"style":{"type":"integer","description":"Style of the voice modulation, 0-1.","example":0.12,"minimum":0,"maximum":1},"use_speaker_boost":{"type":"boolean","description":"Whether to use speaker boost.","example":true}}},"responseFormat":{"type":"string","description":"The audio format of the response (e.g., mp3, opus) defaults mp3 (openai)."},"speed":{"type":"number","format":"float","description":"Speed of the speech playback (openai).","example":1,"minimum":0.25,"maximum":4},"stream":{"type":"boolean","description":"Whether to stream the response.","example":true}}},"AudioSpeechResponse":{"type":"object","properties":{"audioContent":{"type":"string","format":"binary","description":"The binary content of the audio file. Additionally, check the headers for usage details. Example: 'mp3 file', 'header: X-Audio-Details: {\"provider\":\"openai\",\"route\":\"tts-1-hd\",\"model\":\"tts-1-hd\",\"voice\":\"alloy\",\"promptChar\":20,\"cost\":0.00063,\"latencyMs\":1299}'"},"stream":{"type":"object","description":"Stream object if streaming is requested."}}},"EmbeddingRequest":{"type":"object","required":["model","input"],"properties":{"model":{"description":"Model to use for generating embeddings.","type":"string","example":"text-embedding-3-small"},"input":{"description":"Input text to generate embeddings for.","type":"string","example":"why is the sky blue?"},"encoding_format":{"description":"Format of the output encoding. Only supported by OpenAI","type":"string","enum":["float","np"],"example":"float"},"dimensions":{"description":"Number of dimensions for the embedding vector. Maximum value is 384-1536 check the models route for max_tokens per model. Only supported by OpenAI","type":"integer","example":1024,"maximum":1536}}},"EmbeddingResponse":{"type":"object","properties":{"object":{"type":"string","example":"list"},"data":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"embedding"},"index":{"type":"integer","example":0},"embedding":{"type":"object","properties":{"object":{"type":"string","example":"embedding"},"index":{"type":"integer","example":0},"embedding":{"type":"array","items":{"type":"number","example":[0.015207428,-0.0031979256,-0.042056903,0.03562467,0.022221763,-0.0012624348,0.013301042]}}}}}}},"provider":{"type":"string","example":"openai"},"model":{"type":"string","example":"text-embedding-3-small"},"usage":{"type":"object","properties":{"prompt_tokens":{"type":"integer","example":6},"total_tokens":{"type":"integer","example":6},"prompt_characters":{"type":"integer","example":20},"cost":{"type":"string","example":"0.0000001260"},"latency_ms":{"type":"integer","example":349}}}}},"ImageGenerationRequest":{"type":"object","required":["prompt"],"properties":{"prompt":{"type":"string","description":"Text description of the desired image(s)","example":"Its a picture of a dog, driving a car"},"model":{"type":"string","description":"The model to use for image generation","example":"dall-e-3"},"n":{"type":"integer","description":"The number of images to generate, we currently only support one at a time","example":1,"minimum":1,"maximum":1},"size":{"type":"string","description":"The size of the generated images","example":"1024x1024 is supported by all models"},"quality":{"type":"string","description":"The quality of the image that will be generated","example":"standard or hd"},"response_format":{"type":"string","description":"The format in which the generated images are returned, we support either b64_json or \"url\"","example":"url"},"style":{"type":"string","description":"The style of the generated images the options are vivid and natural and does not apply to all providers","example":"vivid"},"image":{"type":"string","description":"The URL to an image you want the image model to update (Not supported by Dall-e-3)","example":"https://apipie.ai/temp/47g43g6f476vf.jpg"},"seed":{"type":"integer","examples":[42,531286735183442],"description":"A randomness initializer for image reproducibility. Check specific models for compatibility.","minimum":0,"maximum":2147483647},"steps":{"type":"integer","default":30,"minimum":1,"maximum":50,"description":"Amount of computational iterations to run. More is typically higher quality. Check specific models for compatibility."},"loras":{"type":"array","maxItems":3,"uniqueItems":true,"items":{"type":"string"},"description":"Augment the output with a LoRa model. Check specific models for compatibility."},"strength":{"type":"number","default":0.6,"minimum":0,"maximum":1,"description":"Controls the strength of the applied effect. Check specific models for compatibility."},"aspect_ratio":{"description":"Aspect Ratio. Check specific models for compatibility.","type":"string","enum":["9:21","21:9"]},"text_layout":{"type":"array","description":"Text layout configuration for image generation. Check specific models for compatibility.","items":{"type":"object","additionalProperties":false,"required":["text","bbox"],"properties":{"text":{"type":"string"},"bbox":{"type":"array","minItems":4,"maxItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number","minimum":0,"maximum":1}}}}}}}},"ImageGenerationResponse":{"type":"object","required":["created","data"],"properties":{"created":{"type":"integer","description":"UTC timestamp of when the image was created"},"data":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"URL of the generated image","example":"https://..."},"revised_prompt":{"type":"string","description":"If exists, the actual prompt that was processed as some providers automatically enhance them","example":"A labrador retriever with lush chocolate fur is driving a red 1974 Stingray and..."}}}}}},"ChatCompletionMessage":{"type":"object","properties":{"role":{"description":"Message role","type":"string","enum":["assistant","system","user"]},"content":{"description":"Content of the message","type":"string"}}},"ChatCompletionRequest":{"description":"","type":"object","required":["messages","model"],"properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/ChatCompletionMessage"},"example":[{"role":"system","content":"Respond in Swedish."},{"role":"assistant","content":"additional data to help the system answer the users prompt"},{"role":"user","content":"Why the sky is blue?"}]},"user":{"description":"Unique identifier for the user, enabling tenant observability for usage and billing, and providing tenant services for memory and inline_cli.","type":"string","example":"12345"},"inline_cli":{"description":"Command to enable or disable inline CLI features. Can be boolean true/false or a comma-delimited string of features like all, disabled, information, integrity, memory, model, search, shaping.  send :help in your prompt for more details","type":"string","example":"all"},"model":{"description":"Language Model to use, comma separated, up to 5 models. Check our /models route for list of language models. Cannot use provider option with multi-model.","type":"string","example":"gpt-3.5-turbo"},"provider":{"description":"AI Service Provider to use, omit provider and we will automatically use the most responsive provider. Optionally you can include provider with the model instead such as model: provider/model","type":"string","example":"openai"},"vector_provider":{"type":"string","enum":["pinecone","qdrant"],"description":"Vector provider to use to store memory and rag tune data, make sure to use the same provider per collection/session."},"memory":{"description":"Enable Integrated Model Memory to maintain conversation context. Set to true to enable memory for this conversation, the default is false.","type":"Boolean","enum":[true,false],"example":true},"mem_session":{"description":"Optional unique identifier for maintaining separate memory chains for different users/applications. If not provided, a default session is used.","type":"string","example":"test3746"},"mem_expire":{"description":"Optional time in minutes after which stored memories will automatically expire and be deleted.","type":"integer","example":60},"mem_clear":{"description":"Set to 1 to instantly delete all stored memories for the specified mem_session.","type":"integer","enum":[0,1],"example":1},"mem_msgs":{"description":"Maximum number of messages to append from memory to the user provided prompts. The default is 8 additional messages","type":"integer","example":10},"mem_length":{"description":"Percentage (1-100) of model's max response tokens to use for memory. For example, 20 on a 100k max response tokens model would allow up to 20k tokens for memory augmentation. The default is 20%","type":"integer","minimum":1,"maximum":100,"example":20},"shortMem":{"description":"Number of recent user–assistant message pairs to keep in short-term memory (state cache). Each pair equals 2 messages. Max: 10 pairs (20 messages). Default: 3.","type":"integer","minimum":0,"maximum":10,"default":3,"example":3},"longMem":{"description":"Number of individual messages to retrieve from long-term memory (vector similarity search). Max: 10 messages. Default: 2.","type":"integer","minimum":0,"maximum":10,"default":2,"example":2},"rag_tune":{"description":"Specify the name of the rag tune or vector collection to be used for RAG tuning. This will augment the language model query with information from the specified vector database.","type":"string","example":"my-files"},"routing":{"description":"Define how we should route your call when you do not specify a provider and multiple providers exist for that model. Options are price (cheapest), multi-tiered performance (routing based on lowest latency for prompt size) and average_latency. The default is perf (price/perf/perf_avg) ","type":"string","example":"perf"},"temperature":{"description":"Influences the randomness in the selection process of the next token. Lower values make the model more deterministic, while higher values increase diversity but might reduce coherence.","type":"number","example":1,"minimum":0,"maximum":2},"top_p":{"description":"Controls the cumulative probability distribution cutoff, selecting the smallest set of tokens whose cumulative probability exceeds the threshold p. This focuses generation on more likely tokens, enhancing creativity and coherence.","type":"number","example":1,"minimum":0,"maximum":1},"top_k":{"description":"Limits the selection pool to the top k most probable tokens. The probability distribution is then reranked among these k tokens, which helps in reducing randomness by eliminating the least likely options.","type":"integer","example":0,"minimum":0},"frequency_penalty":{"description":"Adjusts the likelihood of a token's selection based on its previous occurrences, decreasing the chances of frequently selected tokens to promote diversity in the output.","type":"number","example":0,"minimum":-2,"maximum":2},"presence_penalty":{"description":"Similar to frequency penalty, but it decreases the likelihood of tokens appearing again based on their presence, regardless of frequency, to encourage novel token selection.","type":"number","example":0,"minimum":-2,"maximum":2},"repetition_penalty":{"description":"Discourages the model from repeating the same words or phrases, enhancing the uniqueness and variety of the content generated.","type":"number","example":1,"minimum":1,"maximum":2},"n":{"description":"receive this many responses to your prompt, currently only works with OpenAI direct","type":"integer","example":1,"minimum":1,"maximum":5},"beam_size":{"description":"Used in beam search, it represents the number of sequences to keep at each step of the generation. A larger beam size increases the chances of finding a more optimal sequence but at the cost of computational resources and time. Only some models support this","type":"integer","example":1,"minimum":1,"maximum":5},"search_whitelist":{"description":"Array of root FQDNs to allow for AI search (e.g., [\"apnews.com\", \"bbc.com\", \"reuters.com\"]). If not provided/null, AI can use any URLs that searches present. Applies to all search-augmented completions. Backward compatible: strings (comma-delimited) are also accepted and will be converted to arrays.","type":"array","items":{"type":"string"},"example":["apnews.com","bbc.com","reuters.com"]},"search_blacklist":{"description":"Array of root FQDNs to block for AI search (e.g., [\"cnn.com\", \"foxnews.com\"]). If not provided/null, no URLs are blocked. Applies to all search-augmented completions. Backward compatible: strings (comma-delimited) are also accepted and will be converted to arrays.","type":"array","items":{"type":"string"},"example":["cnn.com","foxnews.com"]},"web_search_options":{"description":"Options for web search context size using Valyu search provider. Controls the amount of search content provided to the model. Defaults to low.","type":"object","properties":{"search_context_size":{"type":"string","enum":["low","medium","high"],"default":"low","description":"- low: 1 search query, 1 result per query\n- medium: 2 search queries, 2 results per query (4 total contents)\n- high: 4 search queries, 2 results per query (8 total contents)\n"}},"example":{"search_context_size":"medium"}},"search_provider":{"description":"Search provider to use for inline internet augmentation. Can be \"valyu\" or \"google\". Default is \"valyu\".","type":"string","enum":["valyu","google"],"example":"valyu"},"search_lang":{"description":"Language code for search results, e.g., en for English.","type":"string","example":"en"},"search_geo":{"description":"Geographical code for search results, e.g., US for United States.","type":"string","example":"US"},"max_tokens":{"description":"Max tokens used to generate a response","type":"integer","example":300,"minimum":1},"stream":{"description":"Return response in event-stream","type":"boolean","default":false},"stream_errors":{"description":"Controls how errors are returned when using streaming responses. Defaults to true.\n- If true (default), all streaming error messages are sent in the message body, which is commonly used for browser clients.\n- If false, errors are thrown and not streamed in the response body. This may not be as comprehensive in some cases where the error happens after the stream starts.\n","type":"boolean","default":true,"example":true},"tools":{"description":"Optional tools/functions, all models support tools, serviced by an Open AI or Anthropic model of your choice. Function calls are handled in Open AI standard request/response format.","type":"array","items":{"type":"object","properties":{"type":{"type":"string","enum":["function"]},"function":{"type":"object","properties":{"name":{"type":"string","description":"Name of the function to call"},"description":{"type":"string","description":"Description of the function"},"parameters":{"type":"object","description":"Parameters required by the function"}}}}},"example":[{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather in a given location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g., San Francisco, CA"},"unit":{"type":"string","enum":["celsius","fahrenheit"]}},"required":["location"]}}}]},"tool_choice":{"description":"Specifies how the tools are chosen. \"none\" means the model will not call any tool and instead generates a message, this is default. \"auto\" means the model can pick between generating a message or calling one or more tools, this is how most devs use it. \"required\" means the model must call one or more tools.","type":"string","example":"auto"},"tools_model":{"description":"Specifies the model to use for processing tools, pass any OpenAI or Anthropic model, gpt-4o-mini is default.","type":"string","example":"claude-3-5-sonnet","default":"gpt-4o-mini"},"integrity":{"description":"Integrity setting, can be 12 or 13, used to query and return best of two answers or the best of 3 answers.","type":"integer","enum":[12,13],"example":12},"integrity_model":{"description":"Specifies model to use for integrity checks, currently only supports OpenAI models.","type":"string","example":"gpt-3.5-turbo","default":"gpt-4o"},"force_provider":{"description":"Force request to be routed to the specified provider, otherwise request will be routed to the requested provider only if it is available","type":"boolean","default":false}}},"VisionChatCompletionMessage":{"type":"object","properties":{"role":{"description":"Role of the message sender","type":"string","enum":["user"]},"content":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string","description":"Textual content of the message"}}},{"type":"object","properties":{"type":{"type":"string","enum":["image_url"]},"image_url":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"URL of the image"},"detail":{"type":"string","enum":["high"],"description":"Detail level of the image, only high supported"}}}}}]}}},"example":{"role":"user","content":[{"type":"text","text":"describe this person"},{"type":"image_url","image_url":{"url":"https://apipie.ai/temp/dlcpieh28hy8vnf.jpg","detail":"high"}}]}},"VisionChatCompletionRequest":{"type":"object","required":["model","messages"],"properties":{"model":{"description":"Vision Model to use, refer to /models route for compatible vision models","type":"string","example":"gpt-4-vision-preview"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/VisionChatCompletionMessage"}},"max_tokens":{"description":"Max tokens used to generate a response","type":"integer","minimum":1,"example":300}}},"ChatCompletionResponse":{"type":"object","required":["id","object","created","provider","model","choices","usage","system_fingerprint"],"properties":{"id":{"type":"string","description":"Unique identifier for the completion."},"object":{"type":"string","description":"Type of the returned object, usually set to chat.completion."},"created":{"type":"integer","description":"UTC timestamp of when the completion was created."},"provider":{"type":"string","description":"Provider of the AI service."},"model":{"type":"string","description":"AI model used for generating the completion."},"choices":{"type":"array","description":"Array of possible completion options generated by the model.","items":{"type":"object","required":["index","message","loqprobs","finish_reason"],"properties":{"index":{"type":"integer","description":"Index of the choice in the array."},"message":{"type":"object","properties":{"role":{"type":"string","description":"Role of the message, such as user or assistant."},"content":{"type":"string","description":"Content of the message."}}},"logprobs":{"type":"object","nullable":true,"description":"Log probabilities for the completion, can be null."},"finish_reason":{"type":"string","description":"Reason why the model stopped generating text."}}}},"search_length":{"type":"integer","description":"Character count augmented to the prompt by the search."},"search_latency_ms":{"type":"integer","description":"Latency in milliseconds added by the search and processing."},"usage":{"type":"object","required":["prompt_tokens","completion_tokens","total_tokens","prompt_characters","response_characters","cost","latency_ms"],"properties":{"prompt_tokens":{"type":"integer","description":"Number of tokens used in the prompt."},"completion_tokens":{"type":"integer","description":"Number of tokens generated in the completion."},"total_tokens":{"type":"integer","description":"Total number of tokens used in both prompt and completion."},"prompt_characters":{"type":"integer","description":"Number of characters used in the prompt."},"response_characters":{"type":"integer","description":"Number of characters in the response."},"cost":{"type":"number","format":"float","description":"Cost associated with the computation of the completion."},"latency_ms":{"type":"integer","description":"Latency in milliseconds for the completion to be generated."}}},"system_fingerprint":{"type":"string","description":"Unique fingerprint of the system configuration used."},"streaming":{"type":"object","description":"Object detailing streaming data chunks if stream is true.","properties":{"type":{"type":"string","description":"Type of the streamed object, usually chat.completion.chunk."},"chunks":{"type":"array","description":"Array of data chunks streamed.","items":{"type":"object","properties":{"content":{"type":"string","description":"Content of the streamed data chunk."},"index":{"type":"integer","description":"Index of the data chunk in the stream."},"finish_reason":{"type":"string","description":"Reason for the finish of this particular chunk."},"usage":{"type":"string","description":"tokens, characters, latency and cost for this query"}}}}}}}},"ParserResponse":{"type":"object","description":"Response containing parsed document data from Tika","properties":{"metadata":{"type":"object","description":"Document metadata extracted by Tika","additionalProperties":true},"content":{"type":"string","description":"Text content extracted from the document"}}},"QuerySchema":{"type":"object","required":["id","username","timestamp","app","provider","model","route","unit","cost","latency_ms"],"properties":{"id":{"description":"Internal ID of the query","type":"number"},"username":{"description":"Name of the user that made the request","type":"string"},"timestamp":{"description":"Date and Time when the request was done in ISO format","type":"string"},"app":{"description":"Name of the API key","type":"string"},"provider":{"description":"AI Service Provider used","type":"string"},"route":{"description":"Unique identifier of the AI model used within the Provider","type":"string"},"unit":{"description":"Unit used for in cost calculations","type":"string"},"prompt_tokens":{"description":"Number of Tokens in the prompt","type":"number"},"prompt_char":{"description":"Number of Characters in the prompt","type":"number"},"response_tokens":{"description":"Number of Tokens in the response","type":"number"},"response_char":{"description":"Number of Characters in the response","type":"number"},"cost":{"description":"Cost of the query, decimal with up to 12 decimal places","type":"string"},"latency_ms":{"description":"Query latency in milliseconds","type":"number"}}},"QueriesResponse":{"type":"object","required":["items","limit","offset"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/QuerySchema"}},"limit":{"type":"number","description":"Limit parameter used in the request"},"offset":{"type":"number","description":"Offset parameter used in the request"}}},"ProcessDocumentRequest":{"type":"object","properties":{"collection_name":{"type":"string","example":"my-ragtune-collection"},"url":{"type":"string","description":"URL of the document to process. Supported file types: PDF, DOC, DOCX, TXT, CSV, XLS, XLSX","example":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"},"metatag":{"type":"string","description":"Optional metadata tag to associate with the document","example":"important-document"},"vector_provider":{"type":"string","enum":["pinecone","qdrant"],"description":"Vector provider to use to store the collection"}}},"ProcessDocumentResponse":{"type":"object","properties":{"message":{"type":"string","example":"Document added to rag_tuning named: my-ragtune-collection"},"result":{"type":"object","additionalProperties":true}}},"ListCollectionsRequest":{"type":"object","properties":{"vector_provider":{"type":"string","enum":["pinecone","qdrant"],"description":"Vector provider to fetch collections for"}}},"ListCollectionsResponse":{"type":"array","items":{"type":"object","properties":{"collection_name":{"type":"string","example":"my-ragtune-collection"}}}},"DeleteCollectionRequest":{"type":"object","properties":{"collection_name":{"type":"string","example":"my-collection"},"delete_all":{"type":"boolean","example":false},"ids":{"type":"array","items":{"type":"string"},"example":["id1","id2"]},"filter":{"type":"object","additionalProperties":true,"example":{"key":"value"}}}},"DeleteCollectionResponse":{"type":"object","properties":{"message":{"type":"string","example":"Collection or vectors deleted successfully"}}},"SearchRequest":{"type":"object","required":["query"],"properties":{"query":{"description":"Search query string","type":"string","example":"latest AI developments"},"search_provider":{"description":"Search provider (google, or valyu (Valyu includes search & scrape in one, with similarity selection))","type":"string","enum":["google","valyu"],"default":"valyu","example":"google"},"geo":{"description":"Country code for localized results","type":"string","default":"us","example":"us"},"lang":{"description":"Language code for search/results","type":"string","default":"en","example":"en"},"results":{"description":"Number of results to return per search (1-100 for google/brightdata, 1-20 for valyu)","type":"integer","default":20,"example":20},"safeSearch":{"description":"Safe search filtering level (1=on, -1=moderate, -2=off) - not supported by valyu","type":"integer","enum":[1,-1,-2],"default":-1,"example":"-1*"},"user":{"description":"User identifier for billing observability purposes","type":"string","example":"user123"},"whitelist":{"description":"Array of sources to include in search results (domains, URLs, or dataset names) - only supported by valyu provider","type":"array","items":{"type":"string"},"example":["arxiv.org","reuters.com","valyu/valyu-arxiv"]},"blacklist":{"description":"Array of sources to exclude from search results (domains, URLs, or dataset names) - only supported by valyu provider","type":"array","items":{"type":"string"},"example":["reddit.com","twitter.com","news.ycombinator.com"]},"max_price":{"description":"Valyu | Maximum price in dollars for a thousand retrievals (CPM). Only applies when provided. If not provided, adjusts automatically based on search type and max number of results.","type":"number","format":"float","minimum":0,"example":30},"start_date":{"description":"Valyu | Start date for time-filtered searches (YYYY-MM-DD)","type":"string","format":"date","example":"2024-01-01"},"end_date":{"description":"Valyu | End date for time-filtered searches (YYYY-MM-DD)","type":"string","format":"date","example":"2024-12-31"},"instructions":{"description":"Custom instructions for query rewriting and result reranking. Max 500 characters. (Preferred over category)","type":"string","maxLength":500,"example":"Focus on peer-reviewed research from the last 2 years"},"relevance_threshold":{"description":"Minimum relevance score (0.0-1.0) for results after reranking. Results below this threshold are filtered out.","type":"number","format":"float","minimum":0,"maximum":1,"default":0.5,"example":0.5},"fast_mode":{"description":"Valyu | Enable fast mode for reduced latency but shorter results. Best for general purpose queries. Cannot be used with search_type \"proprietary\".","type":"boolean","default":false,"example":true},"url_only":{"description":"Return only URLs without full content extraction. Only available when search_type is \"web\" or \"news\". Skips reranking.","type":"boolean","default":false,"example":false},"source_biases":{"description":"Bias values for specific sources to influence ranking without hard filtering. Keys are domains (e.g., \"nasa.gov\") or URL paths. Values are integers from -5 (strong demotion) to +5 (strong boost).","type":"object","additionalProperties":{"type":"integer","minimum":-5,"maximum":5},"example":{"nasa.gov":5,"noaa.gov":3,"nih.gov":1,"example.com":-4}},"response_length":{"description":"valyu | Controls the length of content returned per result. Can be an integer for character count or predefined values: short (25k), medium (50k), large (100k), max (full)","type":"string","example":"medium"},"is_tool_call":{"description":"Valyu | Tunes retrieval process based on whether the API is being called by an AI agent as a tool call, or a user query.","type":"boolean","default":true,"example":false}}},"SearchResultItem":{"type":"object","properties":{"url":{"type":"string","example":"https://example.com/ai-developments"},"title":{"type":"string","example":"Latest Advances in AI Technology"},"description":{"type":"string","example":"Overview of recent breakthroughs in artificial intelligence..."},"rank":{"type":"integer","example":10},"global_rank":{"type":"integer","example":1000}}},"SearchUsage":{"type":"object","properties":{"search_id":{"type":"string","example":"nai-123e4567-e89b-12d3-a456-426614174000"},"timestamp":{"type":"integer","example":1711729795000},"search_provider":{"type":"string","example":"google"},"keywords":{"type":"string","example":"latest AI developments"},"total_records":{"type":"integer","example":1000000},"requested_records":{"type":"integer","example":20},"returned_records":{"type":"integer","example":20},"cost":{"type":"number","format":"float","example":0.03},"latencyMs":{"type":"integer","example":1200}}},"SearchResponse":{"type":"object","properties":{"results":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SearchResultItem"},"example":{"result1":{"url":"https://example.com/page1","title":"Example Page 1","description":"Description of page 1"},"result2":{"url":"https://example.com/page2","title":"Example Page 2","description":"Description of page 2"}}},"usage":{"$ref":"#/components/schemas/SearchUsage"}}},"ScrapeRequest":{"type":"object","required":["url"],"properties":{"url":{"description":"URL to scrape content from","type":"string","example":"https://example.com/article"},"provider":{"description":"Scrape provider (brightdata or valyu)","type":"string","enum":["brightdata","valyu"],"default":"brightdata","example":"valyu"},"format":{"description":"Format of the response (raw or parsed)","type":"string","enum":["raw","parsed"],"default":"parsed","example":"parsed"},"scrape_render":{"description":"Force Javascript to fully render before scraping","type":"Boolean","enum":[true,false],"example":true},"scrape_length":{"description":"Content length for extraction (valyu supports short, medium, large, max, or custom integer 1000-1000000)","type":"string","example":"medium"}}},"ScrapeParsedContent":{"type":"object","properties":{"title":{"type":"string","example":"Article Title"},"textContent":{"type":"string","example":"Full text content of the article..."},"excerpt":{"type":"string","example":"Brief excerpt from the article..."},"hrefs":{"type":"array","items":{"type":"string"},"example":["https://example.com/link1","https://example.com/link2"]}}},"ScrapeUsage":{"type":"object","properties":{"scrape_id":{"type":"string","example":"nai-123e4567-e89b-12d3-a456-426614174000"},"timestamp":{"type":"integer","example":1711729795000},"requested_records":{"type":"integer","example":1},"raw_length":{"type":"integer","example":150000},"parsed_length":{"type":"integer","example":25000},"cost":{"type":"number","format":"float","example":0.015},"latencyMs":{"type":"integer","example":2500}}},"ScrapeResponse":{"type":"object","properties":{"scrape_content":{"oneOf":[{"type":"string","description":"Raw HTML content when format=raw"},{"$ref":"#/components/schemas/ScrapeParsedContent"}]},"usage":{"$ref":"#/components/schemas/ScrapeUsage"}}},"StateSettings":{"type":"object","additionalProperties":false,"description":"Settings persisted per user or per app (api key) depending on scope","properties":{"anon":{"type":"boolean","description":"When true, anonymizes sensitive data in chat completions before sending to AI models and de-anonymizes responses. Only applies to chat completion routes.","example":true},"max_tokens":{"type":"integer","description":"Max tokens used to generate a response to limit response size","example":300,"minimum":1},"memory":{"type":"boolean","enum":[true,false],"example":true},"mem_session":{"type":"string","description":"Optional unique identifier for separate memory chains, otherwise uses \"user\"","example":"user123-sessionA"},"mem_expire":{"type":"integer","description":"Time in minutes before memory expires (expire from time of save)","minimum":1,"example":1440},"integrity":{"type":"integer","description":"Add mulitple response and best answer voting for a single hallucination free response","enum":[11,12,13],"example":12},"model":{"type":"string","description":"Should be in form of provider/model","example":"openai/gpt-4o-mini"},"search_lang":{"type":"string","description":"Alias for lang (kept for compatibility)","minLength":2,"maxLength":5},"search_geo":{"type":"string","description":"Alias for geo (kept for compatibility)","minLength":2,"maxLength":5},"shortMem":{"type":"integer","description":"Number of recent message pairs in short-term memory (max 10)","minimum":0,"maximum":10,"example":3},"longMem":{"type":"integer","description":"Number of individual messages to retrieve from long-term memory (max 10)","minimum":0,"maximum":10,"example":2},"routing":{"type":"string","description":"Routing mode (price/perf/perf_avg)","enum":["price","perf","perf_avg"],"example":"perf"},"tools_model":{"type":"string","description":"If tools call, use this model for tools response, otherwise respond with selected model. openai/anthropic models only.","example":"gpt-4o-mini"},"user":{"type":"string","description":"Sets the user for completion calls when provided in settings. Not compatible with user scoped management.","example":"user487"},"tool_choice":{"type":"string","enum":["none","auto","required"],"example":"auto"},"vector_provider":{"type":"string","description":"Select what vector backend to use for memory and ragTuning. (Only used at creation, must clear and recreate to change provider)","enum":["pinecone","qdrant"],"example":"pinecone"},"search_whitelist":{"description":"Array of root FQDNs to allow for AI search (e.g., [\"apnews.com\", \"bbc.com\", \"reuters.com\"]). If not provided/null, AI can use any URLs that searches present. Applies to all search-augmented completions. Backward compatible: strings (comma-delimited) are also accepted and will be converted to arrays.","type":"array","items":{"type":"string"},"example":["apnews.com","bbc.com","reuters.com"]},"search_blacklist":{"description":"Array of root FQDNs to block for AI search (e.g., [\"cnn.com\", \"foxnews.com\"]). If not provided/null, no URLs are blocked. Applies to all search-augmented completions. Backward compatible: strings (comma-delimited) are also accepted and will be converted to arrays.","type":"array","items":{"type":"string"},"example":["cnn.com","foxnews.com"]},"temperature":{"description":"Influences the randomness in the selection process of the next token. Lower values make the model more deterministic, while higher values increase diversity but might reduce coherence.","type":"number","example":1,"minimum":0,"maximum":2},"top_p":{"description":"Controls the cumulative probability distribution cutoff, selecting the smallest set of tokens whose cumulative probability exceeds the threshold p. This focuses generation on more likely tokens, enhancing creativity and coherence.","type":"number","example":1,"minimum":0,"maximum":1},"top_k":{"description":"Limits the selection pool to the top k most probable tokens. The probability distribution is then reranked among these k tokens, which helps in reducing randomness by eliminating the least likely options.","type":"integer","example":0,"minimum":0},"frequency_penalty":{"description":"Adjusts the likelihood of a token's selection based on its previous occurrences, decreasing the chances of frequently selected tokens to promote diversity in the output.","type":"number","example":0,"minimum":-2,"maximum":2},"presence_penalty":{"description":"Similar to frequency penalty, but it decreases the likelihood of tokens appearing again based on their presence, regardless of frequency, to encourage novel token selection.","type":"number","example":0,"minimum":-2,"maximum":2},"web_search_options":{"description":"Options for web search context size, can be set to low, medium, or high. Defaults to low. Overrides any settings for search, pull, use, and scrape length.","type":"object","additionalProperties":false,"properties":{"search_context_size":{"type":"string","enum":["low","medium","high"],"default":"low"}},"example":{"search_context_size":"medium"}}}},"StateResponse":{"type":"object","properties":{"scope":{"type":"string","enum":["user","app"]},"key":{"type":"string","description":"user (when user scope) or app label (when app scope)"},"settings":{"$ref":"#/components/schemas/StateSettings"},"enable_inline_cli":{"type":"boolean","description":"Whether inline CLI is enabled for this state"},"gui_only":{"type":"boolean","description":"When true, state configuration can only be performed through the APIpie GUI and cannot be edited via API or inline cli. Needs to be app scoped (disable user_states)."}}},"UpsertStateRequest":{"type":"object","additionalProperties":false,"properties":{"enable_user_states":{"type":"boolean","description":"If true, scope is per-user (user_id + user). If false, scope is per-app (user_id + app label)."},"user":{"type":"string","description":"Required when enable_user_states=true. Identifies the end-user.","example":"12345"},"enable_inline_cli":{"type":"boolean","description":"Enable a command line CLI for state management at the prompt, use ':help' in the prompt to any LLM for more details"},"gui_only":{"type":"boolean","description":"When true, state configuration can only be performed through the APIpie GUI and cannot be edited via API or inline cli for this API key."},"settings":{"$ref":"#/components/schemas/StateSettings"},"delete":{"type":"array","description":"Keys to remove from the existing settings (partial delete). Use POST to perform partial key deletes.","items":{"type":"string"}}}},"Error":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"statusCode":{"type":"integer"}}},"FileUploadResponse":{"type":"object","properties":{"url":{"type":"string","description":"URL to access the uploaded file.","example":"https://apipie.ai/temp/uniquefilename.jpg"}}},"CreateCollectionRequest":{"type":"object","properties":{"collection_name":{"type":"string","example":"my-collection"},"dimension":{"type":"integer","example":512},"vector_provider":{"type":"string","enum":["pinecone","qdrant"],"description":"Vector provider to use to store the collection"}}},"CreateCollectionResponse":{"type":"object","properties":{"message":{"type":"string","example":"Vector collection created successfully"}}},"UpdateCollectionRequest":{"type":"object","properties":{"collection_name":{"type":"string","example":"my-collection"},"vector_id":{"type":"string","example":"vector-id-123"},"metatag":{"type":"string","example":"sampleTag"},"data":{"type":"string","example":"This is some clear text data associated with the vector"},"embedding":{"type":"array","items":{"type":"number"},"example":[0.1,0.2,0.3]}}},"ListVectorIdsRequest":{"type":"object","properties":{"collection_name":{"type":"string","example":"my-collection"},"limit":{"type":"integer","example":100},"prefix":{"type":"string","example":"prefix"},"pagination_token":{"type":"string","example":"token123"}}},"ListVectorIdsResponse":{"type":"object","properties":{"vector_ids":{"type":"array","items":{"type":"string"},"example":["id1","id2"]},"next_pagination_token":{"type":"string","example":"next-token-123"}}},"VectorRecordResponse":{"type":"object","properties":{"namespace":{"type":"string","example":"test-namespace-1"},"vectors":{"type":"object","properties":{"vector-id-123":{"type":"object","properties":{"id":{"type":"string","example":"vector-id-123"},"embedding":{"type":"array","items":{"type":"number"},"example":[0.1,0.2,0.3]},"metatag":{"type":"string","example":"sampleTag"},"data":{"type":"string","example":"This is some clear text data associated with the vector"}}}}}}},"QueryVectorsRequest":{"type":"object","properties":{"collection_name":{"type":"string","example":"my-collection"},"vector":{"type":"array","items":{"type":"number"},"example":[0.1,0.2,0.3]},"top_k":{"type":"integer","example":10},"include_values":{"type":"boolean","example":true},"include_metadata":{"type":"boolean","example":false},"filter":{"type":"object","additionalProperties":true,"example":{"key":"value"}},"metatag":{"type":"string","example":"tag123"}}},"VoiceModel":{"type":"object","properties":{"provider":{"type":"string","description":"Provider of the voice model."},"model":{"type":"string","description":"Model identifier."},"voice":{"type":"string","description":"Unique identifier for the voice."},"name":{"type":"string","description":"Name of the voice."},"description":{"type":"string","description":"Description of the voice characteristics."}}},"VoiceModelResponse":{"type":"object","required":["provider","model","voice","name"],"properties":{"object":{"type":"string","description":"Type of the response object, always a list."},"data":{"type":"array","items":{"$ref":"#/components/schemas/VoiceModel"}}},"example":{"object":"list","data":[{"provider":"elevenlabs","model":"eleven_multilingual_v2","voice":"21m00Tcm4TlvDq8ikWAM","name":"Rachel","description":"accent: american, description: calm, age: young, gender: female, use case: narration"},{"...":"Additional models not shown..."}]}},"Restrictions":{"type":"object","properties":{"restrict_id":{"type":"integer","description":"Unique identifier for the restrict table."},"name":{"type":"string","description":"Name or description, usually the provider name."},"countries":{"type":"string","description":"JSON string of supported countries.","example":"{\"countries\":[{\"name\":\"Albania\",\"alpha-2\":\"AL\"},{\"name\":\"Algeria\",\"alpha-2\":\"DZ\"},{\"name\":\"Afghanistan\",\"alpha-2\":\"AF\"}]}"}}},"RestrictionsResponse":{"type":"object","required":["restrict_id","name","countries"],"properties":{"object":{"type":"string","description":"Type of the response object, always a list."},"data":{"type":"array","items":{"$ref":"#/components/schemas/Restrictions"}}},"example":{"object":"list","data":[{"restrict_id":1,"name":"openai","countries":"{\"countries\":[{\"name\":\"Albania\",\"alpha-2\":\"AL\"},{\"name\":\"Algeria\",\"alpha-2\":\"DZ\"},{\"name\":\"Afghanistan\",\"alpha-2\":\"AF\"}]}"},{"...":"Additional restrictions not shown..."}]}},"ModelRequest":{"type":"object","properties":{"enabled":{"type":"integer","description":"1 enabled or 0 disabled","example":1},"type":{"type":"string","enum":["llm","vision","embedding","image","voice","moderation","coding","free"],"description":"Type of the model"},"subtype":{"type":"string","enum":["chat","fill-mask","question-answering","tts","stt","multimodal"],"description":"Subtype of model"},"provider":{"type":"string","description":"Provider of the model"},"model":{"type":"string","description":"The base model name"}}},"Model":{"type":"object","required":["enabled","type","provider","model","route","max_tokens","max_response_tokens","latency","available","query_count"],"properties":{"enabled":{"type":"boolean","description":"Whether Model is enabled"},"type":{"type":"string","enum":["llm","vision","embedding","image","voice","moderation","code"],"description":"Type of the model"},"subtype":{"type":"string","description":"Subtype of the model"},"provider":{"type":"string","description":"Provider of the model"},"model":{"type":"string","description":"The base model name"},"route":{"type":"string","description":"Provider specific identifier"},"description":{"type":"string","description":"Description of the Model"},"max_tokens":{"type":"integer","description":"Max cumulative tokens supported by the model"},"max_response_tokens":{"type":"integer","description":"Max tokens that this model can return in the response"},"req_price":{"type":"string","description":"Price for request - per unit. If not present, price only provided by the provider in query response"},"res_price":{"type":"string","description":"Price for response - per unit. If not present, price only provided by the provider in query response"},"price_unit":{"type":"string","description":"Price unit, the number of price_type per price"},"price_type":{"type":"string","enum":["token","char","request","tokens","image","minute","characters","character","provider"],"description":"Type of the price"},"avg_cost":{"type":"string","description":"Average cost of the model, tracking actual usage. This is the average cost per 1000 characters"},"latency":{"type":"string","description":"Average latency by combined prompt/response size, in the format: 2000/4000/8000/16000/32000/Average_Latency_per_1000_characters"},"available":{"type":"boolean","description":"Availability status of the model"},"query_count":{"type":"string","description":"Total count of queries for this model"}}},"ModelResponse":{"type":"object","properties":{"object":{"type":"string","description":"Type of the list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Model"}}},"example":{"object":"list","data":[{"enabled":1,"type":"llm","subtype":null,"provider":"openrouter","model":"nous-capybara-7b","route":"nousresearch/nous-capybara-7b","description":"The Capybara series is a collection of datasets and models...","max_tokens":4096,"max_response_tokens":4096,"req_price":"0.0000001800000000","res_price":"0.0000001800000000","price_type":"token","price_unit":"1.00","avg_cost":"0.0000912966","latency":"1162/2145/6245/8234/18456/8162","available":1,"query_count":"310,000"},{"...":"Additional models not shown..."}]}},"InputParameter":{"type":"object","properties":{"title":{"type":"string","description":"Human-readable parameter title"},"description":{"type":"string","description":"Detailed parameter description"},"type":{"type":"string","description":"Parameter data type (string, number, integer, boolean, array, object)"},"parent":{"type":"string","description":"Parent parameter if this is a nested parameter"},"allowed":{"type":"boolean","description":"Whether this parameter is allowed"},"required":{"type":"boolean","description":"Whether this parameter is required"},"default":{"description":"Default value for the parameter"},"examples":{"description":"Example values for the parameter"},"minimum":{"type":"number","description":"Minimum value for numeric parameters"},"maximum":{"type":"number","description":"Maximum value for numeric parameters"},"unit_type":{"type":"string","description":"Unit type for the parameter"},"multiple_of":{"type":"number","description":"Value must be a multiple of this number"},"unique_items":{"type":"boolean","description":"Whether array items must be unique"},"enum":{"description":"Allowed enumeration values"},"format":{"type":"string","description":"String format specification"},"is_base_field":{"type":"boolean","description":"Whether this is a base field"}}},"ModelDetailed":{"type":"object","required":["enabled","available","type","provider","id","model","route"],"properties":{"enabled":{"type":"boolean","description":"Whether the model is enabled"},"available":{"type":"boolean","description":"Whether the model is currently available"},"latency":{"type":"string","description":"Average latency by combined prompt/response size"},"query_count":{"type":"integer","description":"Total count of queries for this model"},"type":{"type":"string","description":"Type of the model"},"subtype":{"type":"string","description":"Subtype of the model"},"provider":{"type":"string","description":"Provider of the model"},"id":{"type":"string","description":"Unique identifier for the model"},"model":{"type":"string","description":"The base model name"},"route":{"type":"string","description":"Provider specific identifier"},"description":{"type":"string","description":"Description of the model"},"input_modalities":{"type":"array","items":{"type":"string"},"description":"Input modalities supported by the model"},"output_modalities":{"type":"array","items":{"type":"string"},"description":"Output modalities supported by the model"},"pool":{"type":"string","description":"Pool the model belongs to"},"instruct_type":{"type":"string","description":"Instruction type for the model"},"abortable":{"type":"boolean","description":"Whether requests to the model can be aborted"},"moderationRequired":{"type":"boolean","description":"Whether content moderation is required"},"supports_multipart":{"type":"boolean","description":"Whether multipart requests are supported"},"quantization":{"type":"string","description":"Quantization level of the model"},"mmlu":{"type":"number","description":"MMLU score of the model"},"max_tokens":{"type":"integer","description":"Maximum tokens supported by the model"},"max_response_tokens":{"type":"integer","description":"Maximum tokens in response"},"output_vector_size":{"type":"integer","description":"Size of output vectors from embedding models"},"max_images_per_prompt":{"type":"integer","description":"Maximum images per prompt"},"max_audio_per_prompt":{"type":"integer","description":"Maximum audio files per prompt"},"max_audio_length_hours":{"type":"integer","description":"Maximum audio length in hours"},"max_pdf_size_mb":{"type":"integer","description":"Maximum PDF size in MB"},"max_video_length":{"type":"integer","description":"Maximum video length"},"max_videos_per_prompt":{"type":"integer","description":"Maximum videos per prompt"},"supported_input_parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/InputParameter"},"description":"Input parameters supported by the model with detailed specifications"},"pricing":{"type":"object","properties":{"confirmed":{"type":"object","properties":{"img_price":{"type":"number","description":"Image price"},"avg_cost":{"type":"number","description":"Average cost"},"price_type":{"type":"string","description":"Price type"},"input_cost":{"type":"number","description":"Input cost"},"output_cost":{"type":"number","description":"Output cost"}}},"advertised":{"type":"object","properties":{"img_json":{"type":"object","properties":{"modelfamily":{"type":"object","description":"modelfamily will be the model type ie Flux, SD, SDXL, Dalle-3","properties":{"quality1":{"type":"object","description":"Image quality ie HD or SD","properties":{"resolution1":{"description":"Image resolution price, ie 512x512 = 0.0012 per pixel","type":"number"},"resolution2":{"description":"Image resolution price, ie 1024x1024 = 0.0022 per pixel","type":"number"}}},"quality2":{"type":"object","description":"Image quality ie HD or SD","properties":{"resolution1":{"description":"Image resolution price, ie 512x512 = 0.002 per pixel","type":"number"},"resolution2":{"description":"Image resolution price, ie 1024x1024 = 0.0032 per pixel","type":"number"}}}}}}},"input_cache_read":{"type":"number","description":"Input cache read cost"},"input_cache_write":{"type":"number","description":"Input cache write cost"},"web_search":{"type":"number","description":"Web search cost"},"internal_reasoning":{"type":"number","description":"Internal reasoning cost"},"input_cost_per_token":{"type":"number","description":"Input cost per token"},"output_cost_per_token":{"type":"number","description":"Output cost per token"},"input_cost_per_token_batches":{"type":"number","description":"Input cost per token batches"},"output_cost_per_token_batches":{"type":"number","description":"Output cost per token batches"},"input_cost_per_audio_token":{"type":"number","description":"Input cost per audio token"},"output_cost_per_audio_token":{"type":"number","description":"Output cost per audio token"},"input_cost_per_audio_second":{"type":"number","description":"Input cost per audio second"},"output_cost_per_audio_second":{"type":"number","description":"Output cost per audio second"},"input_cost_per_video_per_second":{"type":"number","description":"Input cost per video per second"},"output_cost_per_video_per_second":{"type":"number","description":"Output cost per video per second"},"input_cost_per_character":{"type":"number","description":"Input cost per character"},"output_cost_per_character":{"type":"number","description":"Output cost per character"}}}}}}},"ModelDetailedResponse":{"type":"object","properties":{"object":{"type":"string","description":"Type of the response object, always a list"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ModelDetailed"}}}},"JSearchRequest":{"type":"object","required":["query"],"properties":{"query":{"description":"Free-form jobs search query. It is highly recommended to include job title and location as part of the query.","type":"string","example":"web development jobs in chicago"},"page":{"description":"Page to return (each page includes up to 10 results)","type":"integer","minimum":1,"maximum":50,"default":1,"example":1},"num_pages":{"description":"Number of pages to return, starting from page","type":"integer","minimum":1,"maximum":50,"default":1,"example":1},"country":{"description":"Country code of the country from which to return job postings","type":"string","default":"us","example":"us"},"language":{"description":"Language code in which to return job postings","type":"string","example":"en"},"date_posted":{"description":"Find jobs posted within the time you specify","type":"string","enum":["all","today","3days","week","month"],"default":"all","example":"all"},"work_from_home":{"description":"Only return work from home / remote jobs","type":"boolean","default":false,"example":false},"employment_types":{"description":"Find jobs of particular employment types, specified as a comma delimited list","type":"string","example":"FULLTIME,CONTRACTOR,PARTTIME,INTERN"},"job_requirements":{"description":"Find jobs with specific requirements, specified as a comma delimited list","type":"string","example":"under_3_years_experience,more_than_3_years_experience,no_experience,no_degree"},"radius":{"description":"Return jobs within a certain distance from location (in km)","type":"integer","example":50},"exclude_job_publishers":{"description":"Exclude jobs published by specific publishers, specified as a comma separated list","type":"string","example":"BeeBe,Dice"},"fields":{"description":"A comma separated list of job fields to include in the response","type":"string","example":"employer_name,job_publisher,job_title,job_country"},"user":{"description":"User identifier for billing observability purposes","type":"string","example":"user123"}}},"JobResultItem":{"type":"object","properties":{"employer_name":{"type":"string"},"employer_logo":{"type":"string"},"job_publisher":{"type":"string"},"job_id":{"type":"string"},"job_employment_type":{"type":"string"},"job_title":{"type":"string"},"job_apply_link":{"type":"string"},"job_description":{"type":"string"},"job_is_remote":{"type":"boolean"},"job_posted_at_timestamp":{"type":"integer"},"job_city":{"type":"string"},"job_state":{"type":"string"},"job_country":{"type":"string"},"rank":{"type":"integer"}}},"JSearchUsage":{"type":"object","properties":{"search_id":{"type":"string","example":"nai-123e4567-e89b-12d3-a456-426614174000"},"timestamp":{"type":"integer","example":1711729795000},"keywords":{"type":"string","example":"web development jobs in chicago"},"requested_records":{"type":"integer","example":10},"total_records":{"type":"integer","example":8},"cost":{"type":"number","format":"float","example":0.01},"latency":{"type":"integer","example":1200}}},"JSearchResponse":{"type":"object","properties":{"dataResults":{"type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/JobResultItem"}},"general":{"type":"object","properties":{"query":{"type":"string"},"results_cnt":{"type":"integer"},"total_jobs":{"type":"integer"},"page":{"type":"integer"},"num_pages":{"type":"integer"}}}}},"queryDetails":{"$ref":"#/components/schemas/JSearchUsage"}}},"RealEstateSearchRequest":{"type":"object","required":["location"],"properties":{"location":{"description":"Location details (county, neighborhood or zip code)","type":"string","maxLength":100,"example":"Los Angeles, CA"},"page":{"description":"Page to return (each page includes up to 41 results)","type":"integer","minimum":1,"maximum":100,"default":1,"example":1},"home_status":{"description":"Filters properties based on their status","type":"string","enum":["FOR_SALE","FOR_RENT","RECENTLY_SOLD"],"default":"FOR_SALE","example":"FOR_SALE"},"home_type":{"description":"Filters by comma-separated list of property types","type":"string","example":"HOUSES,CONDOS_COOPS"},"space_type":{"description":"Find properties with specified space type (works for FOR_RENT home_status type)","type":"string","example":"ENTIRE_PLACE"},"sort":{"description":"Return the results in a specific sort order","type":"string","enum":["DEFAULT","VERIFIED_SOURCE","PRICE_HIGH_LOW","PRICE_LOW_HIGH","NEWEST","BEDROOMS","BATHROOMS","SQUARE_FEET","LOT_SIZE"],"default":"DEFAULT","example":"DEFAULT"},"min_price":{"description":"Sets the minimum price for properties in the search results","type":"number","default":0,"example":500000},"max_price":{"description":"Sets the maximum price for properties in the search results","type":"number","default":0,"example":1000000},"min_monthly_payment":{"description":"Sets the minimum monthly payment for properties (only for FOR_SALE)","type":"number","default":0,"example":2000},"max_monthly_payment":{"description":"Sets the maximum monthly payment for properties (only for FOR_SALE)","type":"number","default":0,"example":5000},"min_bedrooms":{"description":"Filters properties by a minimum number of bedrooms","type":"number","default":0,"example":2},"max_bedrooms":{"description":"Filters properties by a maximum number of bedrooms","type":"number","default":0,"example":4},"min_bathrooms":{"description":"Filters properties by a minimum number of bathrooms","type":"number","default":0,"example":1},"max_bathrooms":{"description":"Filters properties by a maximum number of bathrooms","type":"number","default":0,"example":3},"min_sqft":{"description":"Sets the minimum square footage for properties","type":"number","default":0,"example":1000},"max_sqft":{"description":"Sets the maximum square footage for properties","type":"number","default":0,"example":3000},"min_lot_size":{"description":"Sets the minimum lot size for properties (in square feet)","type":"number","default":0,"example":5000},"max_lot_size":{"description":"Sets the maximum lot size for properties (in square feet)","type":"number","default":0,"example":10000},"listing_type":{"description":"Listing type of the property","type":"string","enum":["BY_AGENT","BY_OWNER_OTHER"],"default":"BY_AGENT","example":"BY_AGENT"},"for_sale_by_agent":{"description":"Filters properties listed by real estate agents","type":"boolean","default":true,"example":true},"for_sale_by_owner":{"description":"Filters properties listed by the owner directly","type":"boolean","default":true,"example":true},"for_sale_is_new_construction":{"description":"Filters for new construction properties","type":"boolean","default":true,"example":true},"for_sale_is_foreclosure":{"description":"Filters for properties that are foreclosures","type":"boolean","default":true,"example":true},"for_sale_is_auction":{"description":"Filters for properties that are for sale at auction","type":"boolean","default":true,"example":true},"for_sale_is_foreclosed":{"description":"Filters for properties which had been foreclosed","type":"boolean","default":false,"example":false},"for_sale_is_preforeclosure":{"description":"Filters for properties in pre-market foreclosure status","type":"boolean","default":false,"example":false},"max_hoa_fee":{"description":"Sets the maximum Homeowners Association (HOA) fee for properties","type":"number","default":0,"example":500},"includes_homes_no_hoa_data":{"description":"Include homes with incomplete HOA data","type":"boolean","default":true,"example":true},"user":{"description":"User identifier for billing observability purposes","type":"string","example":"user123"}}},"RealEstateCoordinatesRequest":{"type":"object","required":["lat","long","diameter"],"properties":{"lat":{"description":"Latitude coordinate","type":"number","format":"float","example":34.01822},"long":{"description":"Longitude coordinate","type":"number","format":"float","example":-118.504744},"diameter":{"description":"Diameter in miles for search area","type":"number","format":"float","example":1},"home_status":{"description":"Filters properties based on their status","type":"string","enum":["FOR_SALE","FOR_RENT","RECENTLY_SOLD"],"default":"FOR_SALE","example":"FOR_SALE"},"home_type":{"description":"Filters by comma-separated list of property types","type":"string","example":"HOUSES,CONDOS_COOPS"},"space_type":{"description":"Find properties with specified space type (works for FOR_RENT home_status type)","type":"string","example":"ENTIRE_PLACE"},"sort":{"description":"Return the results in a specific sort order","type":"string","enum":["DEFAULT","VERIFIED_SOURCE","PRICE_HIGH_LOW","PRICE_LOW_HIGH","NEWEST","BEDROOMS","BATHROOMS","SQUARE_FEET","LOT_SIZE"],"default":"DEFAULT","example":"DEFAULT"},"min_price":{"description":"Sets the minimum price for properties in the search results","type":"number","default":0,"example":500000},"max_price":{"description":"Sets the maximum price for properties in the search results","type":"number","default":0,"example":1000000},"min_monthly_payment":{"description":"Sets the minimum monthly payment for properties (only for FOR_SALE)","type":"number","default":0,"example":2000},"max_monthly_payment":{"description":"Sets the maximum monthly payment for properties (only for FOR_SALE)","type":"number","default":0,"example":5000},"min_bedrooms":{"description":"Filters properties by a minimum number of bedrooms","type":"number","default":0,"example":2},"max_bedrooms":{"description":"Filters properties by a maximum number of bedrooms","type":"number","default":0,"example":4},"min_bathrooms":{"description":"Filters properties by a minimum number of bathrooms","type":"number","default":0,"example":1},"max_bathrooms":{"description":"Filters properties by a maximum number of bathrooms","type":"number","default":0,"example":3},"min_sqft":{"description":"Sets the minimum square footage for properties","type":"number","default":0,"example":1000},"max_sqft":{"description":"Sets the maximum square footage for properties","type":"number","default":0,"example":3000},"min_lot_size":{"description":"Sets the minimum lot size for properties (in square feet)","type":"number","default":0,"example":5000},"max_lot_size":{"description":"Sets the maximum lot size for properties (in square feet)","type":"number","default":0,"example":10000},"listing_type":{"description":"Listing type of the property","type":"string","enum":["BY_AGENT","BY_OWNER_OTHER"],"default":"BY_AGENT","example":"BY_AGENT"},"for_sale_by_agent":{"description":"Filters properties listed by real estate agents","type":"boolean","default":true,"example":true},"for_sale_by_owner":{"description":"Filters properties listed by the owner directly","type":"boolean","default":true,"example":true},"for_sale_is_new_construction":{"description":"Filters for new construction properties","type":"boolean","default":true,"example":true},"for_sale_is_foreclosure":{"description":"Filters for properties that are foreclosures","type":"boolean","default":true,"example":true},"for_sale_is_auction":{"description":"Filters for properties that are for sale at auction","type":"boolean","default":true,"example":true},"for_sale_is_foreclosed":{"description":"Filters for properties which had been foreclosed","type":"boolean","default":false,"example":false},"for_sale_is_preforeclosure":{"description":"Filters for properties in pre-market foreclosure status","type":"boolean","default":false,"example":false},"max_hoa_fee":{"description":"Sets the maximum Homeowners Association (HOA) fee for properties","type":"number","default":0,"example":500},"includes_homes_no_hoa_data":{"description":"Include homes with incomplete HOA data","type":"boolean","default":true,"example":true},"user":{"description":"User identifier for billing observability purposes","type":"string","example":"user123"}}},"RealEstatePolygonRequest":{"type":"object","required":["polygon"],"properties":{"polygon":{"description":"Polygon coordinates string for search area","type":"string","example":"-118.50394248962402 34.02926010734425, -118.5084056854248 34.02926010734425, -118.51286888122559 34.028691046671696, -118.51527214050293 34.02570341552858, -118.51321220397949 34.02257340341831, -118.51750373840332 34.0215774662657, -118.51681709289551 34.017878168811684, -118.51286888122559 34.016455319170184, -118.51080894470215 34.013324966013194, -118.50789070129395 34.010621386310234, -118.50411415100098 34.008629219864694, -118.49982261657715 34.008486920473, -118.49570274353027 34.007063913440916, -118.4919261932373 34.00891381793271, -118.48849296569824 34.01119056813859, -118.4860897064209 34.014463289606894, -118.48471641540527 34.018020452464164, -118.48042488098145 34.01858958468914, -118.4780216217041 34.0215774662657, -118.47939491271973 34.0249920592766, -118.47681999206543 34.02797971546417, -118.47493171691895 34.03125178964367, -118.4721851348877 34.034381481654364, -118.47733497619629 34.035377268536706, -118.48231315612793 34.035377268536706, -118.48677635192871 34.035377268536706, -118.49141120910645 34.03495050416125, -118.49604606628418 34.034096968969656, -118.49621772766113 34.03054047990366, -118.50033760070801 34.02926010734425, -118.50239753723145 34.032532132148006, -118.50394248962402 34.02926010734425"},"home_status":{"description":"Filters properties based on their status","type":"string","enum":["FOR_SALE","FOR_RENT","RECENTLY_SOLD"],"default":"FOR_SALE","example":"FOR_SALE"},"home_type":{"description":"Filters by comma-separated list of property types","type":"string","example":"HOUSES,CONDOS_COOPS"},"space_type":{"description":"Find properties with specified space type (works for FOR_RENT home_status type)","type":"string","example":"ENTIRE_PLACE"},"sort":{"description":"Return the results in a specific sort order","type":"string","enum":["DEFAULT","VERIFIED_SOURCE","PRICE_HIGH_LOW","PRICE_LOW_HIGH","NEWEST","BEDROOMS","BATHROOMS","SQUARE_FEET","LOT_SIZE"],"default":"DEFAULT","example":"DEFAULT"},"min_price":{"description":"Sets the minimum price for properties in the search results","type":"number","default":0,"example":500000},"max_price":{"description":"Sets the maximum price for properties in the search results","type":"number","default":0,"example":1000000},"min_monthly_payment":{"description":"Sets the minimum monthly payment for properties (only for FOR_SALE)","type":"number","default":0,"example":2000},"max_monthly_payment":{"description":"Sets the maximum monthly payment for properties (only for FOR_SALE)","type":"number","default":0,"example":5000},"min_bedrooms":{"description":"Filters properties by a minimum number of bedrooms","type":"number","default":0,"example":2},"max_bedrooms":{"description":"Filters properties by a maximum number of bedrooms","type":"number","default":0,"example":4},"min_bathrooms":{"description":"Filters properties by a minimum number of bathrooms","type":"number","default":0,"example":1},"max_bathrooms":{"description":"Filters properties by a maximum number of bathrooms","type":"number","default":0,"example":3},"min_sqft":{"description":"Sets the minimum square footage for properties","type":"number","default":0,"example":1000},"max_sqft":{"description":"Sets the maximum square footage for properties","type":"number","default":0,"example":3000},"min_lot_size":{"description":"Sets the minimum lot size for properties (in square feet)","type":"number","default":0,"example":5000},"max_lot_size":{"description":"Sets the maximum lot size for properties (in square feet)","type":"number","default":0,"example":10000},"listing_type":{"description":"Listing type of the property","type":"string","enum":["BY_AGENT","BY_OWNER_OTHER"],"default":"BY_AGENT","example":"BY_AGENT"},"for_sale_by_agent":{"description":"Filters properties listed by real estate agents","type":"boolean","default":true,"example":true},"for_sale_by_owner":{"description":"Filters properties listed by the owner directly","type":"boolean","default":true,"example":true},"for_sale_is_new_construction":{"description":"Filters for new construction properties","type":"boolean","default":true,"example":true},"for_sale_is_foreclosure":{"description":"Filters for properties that are foreclosures","type":"boolean","default":true,"example":true},"for_sale_is_auction":{"description":"Filters for properties that are for sale at auction","type":"boolean","default":true,"example":true},"for_sale_is_foreclosed":{"description":"Filters for properties which had been foreclosed","type":"boolean","default":false,"example":false},"for_sale_is_preforeclosure":{"description":"Filters for properties in pre-market foreclosure status","type":"boolean","default":false,"example":false},"max_hoa_fee":{"description":"Sets the maximum Homeowners Association (HOA) fee for properties","type":"number","default":0,"example":500},"includes_homes_no_hoa_data":{"description":"Include homes with incomplete HOA data","type":"boolean","default":true,"example":true},"user":{"description":"User identifier for billing observability purposes","type":"string","example":"user123"}}},"PropertyResultItem":{"type":"object","properties":{"zpid":{"type":"string"},"homeStatus":{"type":"string"},"detailUrl":{"type":"string"},"address":{"type":"string"},"streetAddress":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"country":{"type":"string"},"zipcode":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"homeType":{"type":"string"},"price":{"type":"number"},"currency":{"type":"string"},"zestimate":{"type":"number"},"rentZestimate":{"type":"number"},"taxAssessedValue":{"type":"number"},"lotAreaValue":{"type":"number"},"lotAreaUnit":{"type":"string"},"bathrooms":{"type":"number"},"bedrooms":{"type":"number"},"livingArea":{"type":"number"},"daysOnZillow":{"type":"number"},"isFeatured":{"type":"boolean"},"isPreforeclosureAuction":{"type":"boolean"},"timeOnZillow":{"type":"number"},"isNonOwnerOccupied":{"type":"boolean"},"isPremierBuilder":{"type":"boolean"},"isZillowOwned":{"type":"boolean"},"unit":{"type":"string"},"isShowcaseListing":{"type":"boolean"},"listingSubType":{"type":"object"},"is_FSBA":{"type":"boolean"},"is_openHouse":{"type":"boolean"},"imgSrc":{"type":"string"},"hasImage":{"type":"boolean"},"brokerName":{"type":"string"},"openHouse":{"type":"string"},"priceChange":{"type":"number"},"datePriceChanged":{"type":"number"},"priceReduction":{"type":"string"},"newConstructionType":{"type":"string"},"is_newHome":{"type":"boolean"},"rank":{"type":"integer"}}},"RealEstateUsage":{"type":"object","properties":{"search_id":{"type":"string","example":"nai-123e4567-e89b-12d3-a456-426614174000"},"timestamp":{"type":"integer","example":1711729795000},"location":{"type":"string","example":"Los Angeles, CA"},"requested_records":{"type":"integer","example":41},"total_records":{"type":"integer","example":25},"cost":{"type":"number","format":"float","example":0.01},"latency":{"type":"integer","example":1200}}},"RealEstateResponse":{"type":"object","properties":{"dataResults":{"type":"object","properties":{"properties":{"type":"array","items":{"$ref":"#/components/schemas/PropertyResultItem"}},"general":{"type":"object","properties":{"location":{"type":"string"},"results_cnt":{"type":"integer"},"total_properties":{"type":"integer"},"page":{"type":"integer"},"request_id":{"type":"string"},"parameters":{"type":"object"}}}}},"queryDetails":{"$ref":"#/components/schemas/RealEstateUsage"}}}}},"security":[{"apikey":[]}],"paths":{"/v1/anon":{"post":{"summary":"Anonymize sensitive entities in text","description":"Uses Microsoft Presidio analyzer and anonymizer to detect PII entities in text and replace them with truncated SHA-256 hashes (16 characters). Returns both the anonymized text and a mapping of original values to their anonymized replacements for potential re-identification.\n","tags":["Anon"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonRequest"}}}},"responses":{"200":{"description":"Successfully anonymized text with value mappings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnonResponse"}}}},"400":{"description":"Invalid request - missing or malformed text"},"500":{"description":"Internal server error or Presidio service unavailable"}}}},"/v1/audio/speech":{"post":{"description":"Convert text to speech using the specified model and voice settings.","summary":"Text to Speech Conversion","operationId":"textToSpeechConversion","tags":["Audio"],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"produces":["audio/mpeg","audio/opus","audio/aac","audio/flac","audio/wav","audio/l16"],"requestBody":{"description":"Request parameters for converting text to speech.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AudioSpeechRequest"},"examples":{"openaiRequestExample":{"value":{"provider":"openai","model":"tts-1-hd","input":"why is the sky blue?","voice":"alloy","responseFormat":"mp3","speed":1,"stream":true}},"elevenlabsRequestExample":{"value":{"provider":"elevenlabs","model":"Eleven_Turbo_v2","input":"why is the sky blue?","voice":"21m00Tcm4TIvDq8ikWAM","voiceSettings":{"stability":0.42,"similarity_boost":0.68,"style":0,"use_speaker_boost":true},"stream":true}}}}}},"responses":{"200":{"description":"The audio file or stream returned successfully. Additional usage details are provided in the 'X-Audio-Details' header.","headers":{"X-Audio-Details":{"description":"Provides metadata about the audio request, such as provider, route, model, cost, and latency.","schema":{"type":"string","example":"{\"provider\":\"elevenlabs\",\"route\":\"eleven_multilingual_v2\",\"model\":\"eleven_multilingual_v2\",\"voice\":\"21m00Tcm4TlvDq8ikWAM\",\"promptChar\":20,\"cost\":0.0042,\"latencyMs\":1006}"}}},"content":{"audio/*":{"schema":{"$ref":"#/components/schemas/AudioSpeechResponse"}}}},"400":{"description":"Invalid request parameters."}}}},"/v1/embeddings":{"post":{"description":"Generate embeddings for the given input text using the specified model.\n\nThe `model` field in the request body specifies the model to use. Check the /models route for complete list of embedding models. You can specify the encoding format (`float` or `np`) and the dimensions (up to 1536) of the output embedding vector.\n","summary":"Embeddings LLM","operationId":"embeddingsllm","tags":["Embeddings"],"produces":["application/json"],"requestBody":{"description":"Embedding generation query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingRequest"}}}},"responses":{"200":{"description":"Embedding vector generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingResponse"}}}}}}},"/v1/images/generations":{"post":{"description":"Generates images based on the prompt using OpenAI's image generation API.","summary":"Image Generation","operationId":"imageGeneration","tags":["Images"],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"produces":["application/json"],"requestBody":{"description":"Image generation query with text prompt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageGenerationRequest"}}}},"responses":{"200":{"description":"Result of the Image Generation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageGenerationResponse"}}}}}}},"/v1/chat/completions/inline-cli":{"get":{"summary":"Inline CLI — Command Reference","operationId":"inlineCliReference","tags":["InlineCli"],"description":"The Inline CLI lets you embed `:command` tokens directly inside your chat prompt to dynamically\ncontrol API settings — model selection, internet search, memory, response shaping, and integrity —\nall without any extra API calls.\n\n**How to enable:** include `inline_cli: \"all\"` (or a comma-separated list of feature groups) in\nyour `/v1/chat/completions` request body. Then embed `:command` tokens anywhere in your prompt text.\nCommands are parsed before the LLM call and applied to the request.\n\n**Feature groups:** `model`, `shaping`, `integrity`, `internet`, `memory`, `information`\n\n**State integration:** Commands that include `set` (e.g. `:setmodel`, `:setmemoryon`,\n`:setsearchlang`) automatically persist their changes to the API key state via the State API,\nso subsequent requests inherit the updated configuration without re-sending the command.\n\n**NLP mode:** When NLP is enabled in state, the LLM itself can interpret natural language\ninstructions and emit the appropriate `:command` tokens, enabling fully conversational control\nof API settings by your agent.\n\n---\n\n### Information Commands\n> Direct commands — the prompt is **not** forwarded to the LLM\n\n| Command | Description |\n|---------|-------------|\n| `:getstate` | Returns the current API key state as a JSON response. |\n| `:help` | Returns this command reference. |\n\n---\n\n### Model Commands\n> Switch which model handles this request, persistently or for one query\n\n| Command | Description |\n|---------|-------------|\n| `:setmodel:<provider>/<model>` | Persistently set the model (saved to state). |\n| `:unsetmodel` | Clear the persistent model override. |\n| `:answerwith<name>` | Use a named model for this query only. Options: `openai`, `gpt`, `anthropic`, `claude`, `grok`, `llama`, `gemini`, `deepseek`, `mistral`, `mixtral`, `smart`, `cheap`, `coding`. |\n\n---\n\n### Shaping Commands\n> Adjust temperature, top_p, and penalty settings\n\n| Command | Description |\n|---------|-------------|\n| `:beprecise` | temperature=0.2, top_p=0.5 |\n| `:bebalanced` | temperature=0.5, top_p=0.8 |\n| `:becreative` | temperature=0.9, top_p=0.95 |\n| `:becrazy` | temperature=1.5, top_p=1.0 |\n| `:becoder` | temperature=0.1, top_p=0.4, penalties=0 |\n| `:avoidrepeat` | frequency_penalty=1.2 |\n| `:answerdiverse` | presence_penalty=1.2 |\n| `:stayontopic` | presence_penalty=0, frequency_penalty=0 |\n\n---\n\n### Integrity Commands\n> Reduce hallucinations by querying multiple times and selecting the best answer\n\n| Command | Description |\n|---------|-------------|\n| `:unsetintegrity` | Disable integrity mode. |\n| `:setintegrity` | Enable integrity (best of 2) — saved to state. |\n| `:setsuperintegrity` | Enable super integrity (best of 3) — saved to state. |\n| `:answerintegrity` | Enable integrity for this query only. |\n| `:answersuperintegrity` | Enable super integrity for this query only. |\n\n---\n\n### Internet Search Commands\n> Augment the prompt with live web search results before sending to the LLM\n\n| Command | Description |\n|---------|-------------|\n| `:search` | Low-depth web search (1 query, 1 result). |\n| `:searchmore` | Medium-depth web search (2 queries, 2 results each). |\n| `:deepsearch` | High-depth web search (4 queries, 2 results each). |\n| `:setsearchlang:<code>` | Set search language (2-letter ISO code, e.g. `en`). Saved to state. |\n| `:setsearchgeo:<code>` | Set search geography (2-letter country code, e.g. `US`). Saved to state. |\n\n---\n\n### Memory Commands\n> Control conversation memory (stored in vector DB, keyed by session)\n\n| Command | Description |\n|---------|-------------|\n| `:setmemoryon` | Enable memory for this session. Saved to state. |\n| `:setmemoryoff` | Disable memory. Saved to state. |\n| `:clearmemory` | Clear all stored memory for the current session. |\n| `:setmemexpire:<minutes>` | Set memory TTL in minutes (5–1440). Saved to state. |\n","security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"responses":{"200":{"description":"This path is documentation-only. Use POST /v1/chat/completions with inline_cli enabled."}}}},"/v1/chat/completions":{"parameters":null,"post":{"description":"Query LLM using text and, for vision-capable models, image data. This endpoint supports multiple models (up to 5, comma-separated) in the model field. Specify the appropriate request format depending on whether the model is text-based or vision-capable.\n\nAn array of responses: will be returned for multi-model queries.\n\nPlease refer to the ChatCompletionRequest for text-based models and VisionChatCompletionRequest for vision-capable models for detailed request formats.\n","summary":"Chat Completions","operationId":"chatcompletions","tags":["Chat"],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"produces":["application/json"],"requestBody":{"description":"Chat Completion query which can include either text or image data based on the model capability. Refer to the appropriate schema based on the model type.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ChatCompletionRequest"},{"$ref":"#/components/schemas/VisionChatCompletionRequest"}]},"examples":{"chatExample":{"value":{"messages":[{"role":"user","content":"Why the sky is blue?"}],"model":"gpt-3.5-turbo","memory":1,"mem_session":"test3746"}},"visionExample":{"value":{"messages":[{"role":"user","content":[{"type":"text","text":"describe this person"},{"type":"image_url","image_url":{"url":"https://apipie.ai/temp/dlcpieh28hy8vnf.jpg","detail":"high"}}]}],"model":"gpt-4-vision-preview"}},"toolsExample":{"value":{"model":"claude-3.5-sonnet","messages":[{"role":"user","content":"What is the current weather in Dallas, TX?"}],"tools":[{"type":"function","function":{"name":"get_current_weather","description":"Get the current weather in a given location","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g., San Francisco, CA"},"unit":{"type":"string","enum":["celsius","fahrenheit"]}},"required":["location"]}}},{"type":"function","function":{"name":"get_public_officials","description":"Get the governor, mayor, and congressmen for a city and state in the US","parameters":{"type":"object","properties":{"location":{"type":"string","description":"The city and state, e.g., San Francisco, CA"},"position":{"type":"string","enum":["governor","mayor","congressman"]}},"required":["location"]}}}],"tool_choice":"auto"}}}}}},"responses":{"200":{"description":"Result of the Query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatCompletionResponse"}}}}}}},"/v1/parser":{"post":{"summary":"Parse document content and metadata using Apache Tika","description":"Uses Apache Tika server to extract metadata and/or content from supported document types. Accepts PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX, TXT, RTF, ODT, ODP, ODS, EPUB, HTML & XML. Supports file uploads under 5MB. Returns text content and/or metadata.\n","tags":["Parser"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"Document file to parse"},"metadata":{"type":"boolean","description":"Extract metadata from document","default":true},"content":{"type":"boolean","description":"Extract text content from document","default":true}}}}}},"responses":{"200":{"description":"Successfully parsed document with metadata and/or content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParserResponse"}}}},"400":{"description":"Invalid request - missing file, unsupported file type, or file too large"},"500":{"description":"Internal server error or Tika service unavailable"}}}},"/v1/queries/":{"get":{"description":"Fetch history of queries sorted by Timestamp in Descending order.\n","summary":"Queries History","operationId":"queries","tags":["Queries"],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"produces":["application/json"],"parameters":[{"in":"query","name":"limit","schema":{"type":"integer","minimum":0,"maximum":100,"default":50},"description":"Limit number of returned queries per page (max 100)"},{"in":"query","name":"offset","schema":{"type":"integer","minimum":0,"default":0},"description":"Offset used for pagination"},{"in":"query","name":"show","schema":{"type":"string","enum":["all","hourly","daily","weekly"],"default":"daily"},"description":"Which table to query:\n- `all`: all records\n- `hourly`: hourly aggregation\n- `daily`: daily aggregation (default)\n- `weekly`: weekly aggregation\n"},{"in":"query","name":"days","schema":{"type":"integer","minimum":1,"default":30},"description":"How many days of history to return (minimum 1, default 30)"},{"in":"query","name":"user","schema":{"type":"string","maxLength":14,"pattern":"^[a-zA-Z0-9]+$"},"description":"Filter by user (letters and numbers only, max 14 chars)"},{"in":"query","name":"app","schema":{"type":"string","maxLength":14,"pattern":"^[a-zA-Z0-9]+$"},"description":"Filter by app (letters and numbers only, max 14 chars)"},{"in":"query","name":"provider","schema":{"type":"string","maxLength":14,"pattern":"^[a-zA-Z0-9]+$"},"description":"Filter by provider (letters and numbers only, max 14 chars)"},{"in":"query","name":"route","schema":{"type":"string","maxLength":14,"pattern":"^[a-zA-Z0-9]+$"},"description":"Filter by route/model (letters and numbers only, max 14 chars)"}],"responses":{"200":{"description":"Queries Listing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueriesResponse"}}}}}}},"/ragtune":{"post":{"summary":"Process a document for RAG tuning","description":"Processes a document by extracting its content and generating embeddings to be used for RAG tuning.\nSupported file types: **PDF**, **DOC**, **DOCX**, **TXT**, **CSV**, **XLS**, **XLSX**.\n","operationId":"processDocument","tags":["Ragtune"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessDocumentRequest"}}}},"responses":{"200":{"description":"Document processed and added to the specified collection","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessDocumentResponse"}}}},"400":{"description":"Collection or URL missing from the request"},"500":{"description":"Internal server error"}},"security":[{"apikey":[]}]}},"/ragtune/listcollections":{"post":{"summary":"List collections for RAG tuning","description":"Returns a list of collections associated with the user identified by the API key.\nFor more granular control or to implement your own RAG solution, refer to our `/vectors` route.\n","operationId":"listCollections","tags":["Ragtune"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCollectionsRequest"}}}},"responses":{"200":{"description":"List of collections","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCollectionsResponse"}}}},"500":{"description":"Internal server error"}},"security":[{"apikey":[]}]}},"/ragtune/delete":{"post":{"summary":"Delete a collection","description":"Deletes an entire collection. If you need more fine-grained deletion controls (e.g., deleting specific records), use the `/vectors` endpoint.\n","operationId":"deleteCollection","tags":["Ragtune"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCollectionRequest"}}}},"responses":{"200":{"description":"Collection deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCollectionResponse"}}}},"400":{"description":"Collection name missing from the request"},"500":{"description":"Internal server error"}},"security":[{"apikey":[]}]}},"/v1/search":{"post":{"description":"Perform a web search and return results","summary":"Web Search","operationId":"webSearch","tags":["Search"],"produces":["application/json"],"requestBody":{"description":"Search query parameters","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}}},"responses":{"200":{"description":"Successful search with results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}}},"400":{"description":"Bad request or search failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Query parameter is required"}}}}}}}}},"/v1/search/answer":{"post":{"description":"Generate AI-powered answers using search results (valyu provider only)","summary":"Search Answer","operationId":"searchAnswer","tags":["Search"],"produces":["application/json"],"requestBody":{"description":"Answer generation parameters","required":true,"content":{"application/json":{"schema":{"type":"object","required":["query","search_provider"],"properties":{"query":{"description":"Question to answer","type":"string","example":"What are the latest developments in quantum computing?"},"search_provider":{"description":"Search provider (must be valyu)","type":"string","enum":["valyu"],"example":"valyu"},"search":{"description":"Search type (web, proprietary, all, news)","type":"string","enum":["web","proprietary","all","news"],"default":"all","example":"all"},"results":{"description":"Number of search results to use (1-10)","type":"integer","default":5,"example":5},"fastMode":{"description":"Enable fast mode for reduced latency","type":"boolean","default":false,"example":false},"user":{"description":"User identifier for billing observability purposes","type":"string","example":"user123"},"whitelist":{"description":"Array of sources to include in search results (domains, URLs, or dataset names)","type":"array","items":{"type":"string"},"example":["arxiv.org","reuters.com","valyu/valyu-arxiv"]},"blacklist":{"description":"Array of sources to exclude from search results (domains, URLs, or dataset names)","type":"array","items":{"type":"string"},"example":["reddit.com","twitter.com","news.ycombinator.com"]},"source_biases":{"description":"Bias values for specific sources to influence ranking without hard filtering. Keys are domains (e.g., \"nasa.gov\") or URL paths. Values are integers from -5 (strong demotion) to +5 (strong boost).","type":"object","additionalProperties":{"type":"integer","minimum":-5,"maximum":5},"example":{"nasa.gov":5,"noaa.gov":3,"nih.gov":1,"example.com":-4}},"max_price":{"description":"Maximum price in dollars for a thousand retrievals (CPM). Only applies when provided. If not provided, adjusts automatically based on search type and max number of results.","type":"number","format":"float","minimum":0,"example":30},"timeRange":{"description":"Time range filter. Can be string format (e.g., \"7d\" for last 7 days) or object with start_date/end_date (YYYY-MM-DD)","oneOf":[{"type":"string","example":"7d"},{"type":"object","properties":{"start_date":{"type":"string","format":"date","example":"2024-01-01"},"end_date":{"type":"string","format":"date","example":"2024-12-31"}}}]},"geo":{"description":"Country code for localized results","type":"string","default":"us","example":"us"},"system_instructions":{"description":"System instructions for the answer generation","type":"string","maxLength":500,"example":"Focus on technical details and cite specific research papers"}}}}}},"responses":{"200":{"description":"Successful answer generation","content":{"application/json":{"schema":{"type":"object","properties":{"answer":{"type":"string","description":"AI-generated answer","example":"Recent quantum computing developments include..."},"sources":{"type":"array","description":"Sources used for the answer","items":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string"}}}},"usage":{"$ref":"#/components/schemas/SearchUsage"}}}}}},"400":{"description":"Bad request or answer generation failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Answer functionality is only supported with valyu provider"}}}}}}}}},"/v1/scrape":{"post":{"description":"Scrape content from a webpage","summary":"Web Scraping","operationId":"webScrape","tags":["Search"],"produces":["application/json"],"requestBody":{"description":"Scrape parameters","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeRequest"}}}},"responses":{"200":{"description":"Successful scrape with content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScrapeResponse"}}}},"400":{"description":"Bad request or scrape failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"URL parameter is required"}}}}}}}}},"/v1/state":{"get":{"summary":"Get current state settings","tags":["State"],"description":"When called without query parameters this returns the master/app state for the API key/app. To retrieve a specific user's state, provide `?user={userId}`.\n","security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"parameters":[{"in":"query","name":"user","schema":{"type":"string"},"description":"Optional. If provided, returns the state for the specified user. If omitted, returns the app-level (master) state for the current API key/app."},{"in":"query","name":"app_name","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[A-Za-z0-9 _+-]{1,256}$"},"description":"Optional. Enables the ablity for centralized APIkey state management for enterprises."}],"responses":{"200":{"description":"Current state (app-level or user-level)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateResponse"}}}}}},"post":{"summary":"Create/Update state settings(merge).","tags":["State"],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"parameters":[{"in":"query","name":"app_name","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[A-Za-z0-9 _+-]{1,256}$"},"description":"Optional. Enables the ablity for centralized APIkey state management for enterprises."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertStateRequest"}}}},"responses":{"200":{"description":"Updated state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateResponse"}}}}}},"delete":{"summary":"Delete entire state records","description":"Deletes the entire state record(s). If `?user={userId}` is provided, deletes the record for that user. If `user` is omitted, deletes all state records for the current API key/app (i.e. app-level deletion). Partial deletes of specific keys SHOULD be performed via POST with the `delete` array in the request body.\n","tags":["State"],"security":[{"BearerAuth":[]},{"ApiKeyAuth":[]}],"parameters":[{"in":"query","name":"user","schema":{"type":"string"},"description":"Optional. If provided, delete state for the specified user. If omitted, delete all state records for this API key/app."},{"in":"query","name":"app_name","schema":{"type":"string","minLength":1,"maxLength":256,"pattern":"^[A-Za-z0-9 _+-]{1,256}$"},"description":"Optional. Enables the ablity for centralized APIkey state management for enterprises."}],"responses":{"200":{"description":"Remaining state (or empty when record(s) removed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StateResponse"}}}}}}},"/v1/audio/transcriptions":{"post":{"tags":["Audio"],"summary":"Transcribe audio to text","description":"Transcribes audio files using OpenAI-compatible models. Accepts multipart/form-data.\nSupported models: whisper-1, gpt-4o-transcribe, gpt-4o-mini-transcribe.\nSupported file types: mp3, mp4, mpeg, mpga, m4a, wav, webm.\n","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","required":["file","model"],"properties":{"file":{"type":"string","format":"binary","description":"Audio file to transcribe (max 25MB)"},"model":{"type":"string","enum":["whisper-1","gpt-4o-transcribe","gpt-4o-mini-transcribe"],"description":"Model to use for transcription"},"prompt":{"type":"string","description":"Optional prompt to improve transcription quality"},"response_format":{"type":"string","enum":["json","text","srt","verbose_json","vtt"],"description":"Output format (see OpenAI docs; gpt-4o* only supports json/text)"},"temperature":{"type":"number","description":"Sampling temperature, between 0 and 1"},"language":{"type":"string","description":"ISO 639-1 or 639-3 language code"},"timestamp_granularities":{"type":"array","items":{"type":"string","enum":["word","segment"]},"description":"Only for whisper-1 with verbose_json"},"stream":{"type":"boolean","description":"Whether to stream the response"}}}}}},"responses":{"200":{"description":"Successful transcription response","content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"},"usage":{"type":"object"}}}},"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"string"},"statusCode":{"type":"number"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/urlshare":{"post":{"summary":"Upload a file and retrieve URL","description":"Uploads a file to the server and returns a URL where the uploaded file can be accessed temporarily. This endpoint supports uploading images only, images shoudl be 1024x1024, or 1024x768 or 768x1024, otherwise they will be resized automatically. Files larger than 5mb will be rejected.\n","operationId":"uploadFile","tags":["Urlshare"],"consumes":["multipart/form-data"],"produces":["application/json"],"requestBody":{"description":"File to be uploaded. Only images under 5mb are allowed.","required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File to be uploaded. Supported formats include .png, .jpg, .jpeg, .svg, .gif, .bmp, .tif, .tiff, .webp"}}}}}},"responses":{"200":{"description":"File uploaded successfully and URL returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadResponse"}}}},"400":{"description":"No file uploaded or the file type is not supported"},"500":{"description":"Internal server error or unable to save file"}},"security":[{"apikey":[]}]}},"/vectors":{"post":{"summary":"Create a new vector collection","description":"Creates a new vector collection with the specified name and dimension. (equivalent to creating an index and namespace on pinecone)","operationId":"createCollection","tags":["Vectors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCollectionRequest"}}}},"responses":{"200":{"description":"Collection created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCollectionResponse"}}}},"400":{"description":"Bad request"},"404":{"description":"Collection not found"},"500":{"description":"Internal server error"}},"security":[{"apikey":[]}]}},"/vectors/listcollections":{"post":{"summary":"List vector collections","description":"Returns a list of vector collections for the authenticated user. A collection is equivalent to a namespace, this is not a pinecone enterprise \"collection\".","operationId":"listVectorCollections","tags":["Vectors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"List of vector collections","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Bad request"},"500":{"description":"Internal server error"}},"security":[{"apikey":[]}]}},"/vectors/delete":{"post":{"summary":"Delete a vector collection or specific vectors","description":"Deletes the entire collection or specified vector IDs from the collection.","operationId":"deleteVectorCollection","tags":["Vectors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCollectionRequest"}}}},"responses":{"200":{"description":"Collection or vectors deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCollectionResponse"}}}},"400":{"description":"Bad request"},"404":{"description":"Collection not found"},"500":{"description":"Internal server error"}},"security":[{"apikey":[]}]}},"/vectors/upsert":{"put":{"summary":"Update or insert a vector into a collection","description":"Upserts a vector into the specified collection with metadata and data.","operationId":"updateVectorCollection","tags":["Vectors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCollectionRequest"}}}},"responses":{"200":{"description":"Vector upserted successfully"},"400":{"description":"Bad request"},"404":{"description":"Collection not found"},"500":{"description":"Internal server error"}},"security":[{"apikey":[]}]}},"/vectors/list":{"post":{"summary":"List vector IDs in a collection","description":"Retrieves a list of vector IDs for the specified collection.","operationId":"listVectorIds","tags":["Vectors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVectorIdsRequest"}}}},"responses":{"200":{"description":"Vector IDs retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVectorIdsResponse"}}}},"400":{"description":"Bad request"},"404":{"description":"Collection not found"},"500":{"description":"Internal server error"}},"security":[{"apikey":[]}]}},"/vectors/fetch":{"get":{"summary":"Get a specific record in a vector collection","description":"Fetches the content of a specific record in the vector collection by ID.","operationId":"getVectorRecord","tags":["Vectors"],"parameters":[{"name":"collection_name","in":"query","required":true,"schema":{"type":"string"}},{"name":"ids","in":"query","required":true,"schema":{"type":"string","example":"vector-id-123"}}],"responses":{"200":{"description":"Record retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorRecordResponse"}}}},"400":{"description":"Bad request"},"404":{"description":"Record or collection not found"},"500":{"description":"Internal server error"}},"security":[{"apikey":[]}]}},"/vectors/query":{"post":{"summary":"Query vectors in a collection","description":"Queries the vectors in the specified collection based on input criteria.","operationId":"queryVectors","tags":["Vectors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryVectorsRequest"}}}},"responses":{"200":{"description":"Query results retrieved successfully"},"400":{"description":"Bad request"},"404":{"description":"Collection not found"},"500":{"description":"Internal server error"}},"security":[{"apikey":[]}]}},"/v1/models":{"get":{"description":"Fetch all available models or use one or more filters","summary":"Fetch Models","operationId":"fetchmodels","tags":["Models"],"produces":["application/json"],"parameters":[{"in":"query","name":"type","description":"Filter by type of model.","required":false,"schema":{"type":"string","enum":["llm","vision","embedding","image","voice","moderation","coding","free"]},"examples":{"llm":{"summary":"Filter by type 'llm' language models","value":"llm"},"voice":{"summary":"Filter by type 'voice' (tts and stt)","value":"voice"}}},{"in":"query","name":"subtype","description":"Filter by subtype of model.","required":false,"schema":{"type":"string","enum":["chat","fill-mask","question-answering","tts","stt","multimodal"]},"examples":{"chat":{"summary":"Filter by subtype 'chat'","value":"chat"}}},{"in":"query","name":"provider","description":"Filter by provider of the model.","required":false,"schema":{"type":"string"},"examples":{"openrouter":{"summary":"Filter by provider 'openrouter'","value":"openrouter"}}},{"in":"query","name":"combination","description":"Filter by a combination of provider and subtype.","required":false,"schema":{"type":"string"},"examples":{"providerAndSubtype":{"summary":"Filter by provider 'openrouter' and subtype 'chat'","value":"provider=openrouter&subtype=chat"}}},{"in":"query","name":"enabled","description":"only show enabled chat models","required":false,"schema":{"type":"integer","enum":[1,0]},"examples":{"enabledAndSubtype":{"summary":"only show enabled chat models","value":"enabled=1&subtype=chat"}}},{"in":"query","name":"voices","description":"Retrieve a complete list of available voices. just use /v1/models?voices do not include any other value","required":false,"schema":{"type":"parameter"},"examples":{"voices":{"summary":"Display list of voices for tts voice models, just use /v1/models?voices'","value":"voices"}}},{"in":"query","name":"restrictions","description":"Retrieve a complete list of available Country Restrictions. just use /v1/models?restrictions do not include any other value","required":false,"schema":{"type":"string"},"examples":{"restrictions":{"summary":"Display list of different provider supported countries lists, just use /v1/models?restrictions'","value":"restrictions"}}}],"responses":{"200":{"description":"Models or voices list depending on query parameter used.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ModelResponse"},{"$ref":"#/components/schemas/VoiceModelResponse"},{"$ref":"#/components/schemas/RestrictionsResponse"}]},"examples":{"Models":{"summary":"Example response for a models request","value":{"object":"list","data":[{"enabled":1,"type":"llm","subtype":null,"provider":"openrouter","model":"nous-capybara-7b","route":"nousresearch/nous-capybara-7b","description":"The Capybara series...","max_tokens":4096,"max_response_tokens":4096,"req_price":"0.0000001800000000","res_price":"0.0000001800000000","price_type":"token","price_unit":"1.00","avg_cost":"0.0000912966","latency":"1162/na/na/na/na/1162","available":1,"query_count":"310"},{"...":"Additional models not shown..."}]}},"Voices":{"summary":"Example voice models response for a models query with the '?voices' parameter","value":{"object":"list","data":[{"provider":"elevenlabs","model":"eleven_multilingual_v2","voice":"21m00Tcm4TlvDq8ikWAM","name":"Rachel","description":"accent: american, description: calm, age: young, gender: female, use case: narration"},{"provider":"elevenlabs","model":"eleven_turbo_v2","voice":"zrHiDhphv9ZnVXBqCLjz","name":"Mimi","description":"accent: english-swedish, description: childish, age: young, gender: female, use case: animation"},{"...":"Additional models not shown..."}]}},"Restrictions":{"summary":"Example country restrictions response for a models query with the '?restrictions' parameter","value":{"object":"list","data":[{"restrict_id":2,"name":"openai","countries":"{\"countries\":[{\"name\":\"Albania\",\"alpha-2\":\"AL\"},{\"name\":\"Algeria\",\"alpha-2\":\"DZ\"},{\"name\":\"Afghanistan\",\"alpha-2\":\"AF\"}]}"},{"restrict_id":3,"name":"anthropic","countries":"{\"countries\":[{\"name\":\"Germany\",\"alpha-2\":\"DE\"},{\"name\":\"France\",\"alpha-2\":\"FR\"},{\"name\":\"Spain\",\"alpha-2\":\"ES\"}]}"},{"...":"Additional restrictions not shown..."}]}}}}}}}}},"/v1/models/detailed":{"get":{"description":"Fetch detailed information about models","summary":"Fetch Detailed Models","operationId":"fetchdetailedmodels","tags":["Models"],"produces":["application/json"],"parameters":[{"in":"query","name":"type","description":"Filter by type of model","required":false,"schema":{"type":"string"}},{"in":"query","name":"provider","description":"Filter by provider","required":false,"schema":{"type":"string"}},{"in":"query","name":"model","description":"Filter by model name","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of detailed models","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelDetailedResponse"}}}}}}},"/v1/data/jsearch":{"post":{"description":"Search for jobs using JSearch API through RapidAPI","summary":"Job Search","operationId":"jobSearch","tags":["Data"],"produces":["application/json"],"requestBody":{"description":"Job search parameters","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSearchRequest"}}}},"responses":{"200":{"description":"Successful job search with results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JSearchResponse"}}}},"400":{"description":"Bad request or search failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Query parameter is required"}}}}}},"401":{"description":"Unauthorized - invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid or missing API key"}}}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Insufficient credits, add more https://apipie.ai/profile/subscribe"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Search failed in JSearch API"}}}}}}}}},"/v1/data/real-estate/search":{"post":{"description":"Search for real estate properties by location using Real Estate API through RapidAPI","summary":"Real Estate Search by Location","operationId":"realEstateSearch","tags":["Data"],"produces":["application/json"],"requestBody":{"description":"Real estate search parameters by location","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealEstateSearchRequest"}}}},"responses":{"200":{"description":"Successful real estate search with results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealEstateResponse"}}}},"400":{"description":"Bad request or search failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Location parameter is required"}}}}}},"401":{"description":"Unauthorized - invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid or missing API key"}}}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Insufficient credits, add more https://apipie.ai/profile/subscribe"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Search failed in Real Estate API"}}}}}}}}},"/v1/data/real-estate/coordinates":{"post":{"description":"Search for real estate properties by coordinates using Real Estate API through RapidAPI","summary":"Real Estate Search by Coordinates","operationId":"realEstateCoordinates","tags":["Data"],"produces":["application/json"],"requestBody":{"description":"Real estate search parameters by coordinates","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealEstateCoordinatesRequest"}}}},"responses":{"200":{"description":"Successful real estate search with results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealEstateResponse"}}}},"400":{"description":"Bad request or search failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Lat, long, and diameter parameters are required"}}}}}},"401":{"description":"Unauthorized - invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid or missing API key"}}}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Insufficient credits, add more https://apipie.ai/profile/subscribe"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Search failed in Real Estate API"}}}}}}}}},"/v1/data/real-estate/polygon":{"post":{"description":"Search for real estate properties by polygon area using Real Estate API through RapidAPI","summary":"Real Estate Search by Polygon","operationId":"realEstatePolygon","tags":["Data"],"produces":["application/json"],"requestBody":{"description":"Real estate search parameters by polygon area","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealEstatePolygonRequest"}}}},"responses":{"200":{"description":"Successful real estate search with results","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealEstateResponse"}}}},"400":{"description":"Bad request or search failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Polygon parameter is required"}}}}}},"401":{"description":"Unauthorized - invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid or missing API key"}}}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Insufficient credits, add more https://apipie.ai/profile/subscribe"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Search failed in Real Estate API"}}}}}}}}},"/v1/data/real-estate/address":{"post":{"description":"Get detailed property information by address using Real Estate API through RapidAPI","summary":"Property Details by Address","operationId":"realEstatePropertyDetails","tags":["Data"],"produces":["application/json"],"requestBody":{"description":"Property details request parameters","required":true,"content":{"application/json":{"schema":{"type":"object","required":["address"],"properties":{"address":{"description":"Full property address","type":"string","maxLength":200,"example":"1161 Natchez Dr College Station Texas 77845"},"user":{"description":"User identifier for billing observability purposes","type":"string","example":"user123"}}}}}},"responses":{"200":{"description":"Successful property details lookup","content":{"application/json":{"schema":{"type":"object","properties":{"dataResults":{"type":"object","properties":{"property":{"type":"object","description":"Detailed property information"},"general":{"type":"object","properties":{"address":{"type":"string"},"request_id":{"type":"string"},"parameters":{"type":"object"}}}}},"queryDetails":{"type":"object","properties":{"search_id":{"type":"string"},"timestamp":{"type":"integer"},"address":{"type":"string"},"requested_records":{"type":"integer"},"total_records":{"type":"integer"},"cost":{"type":"number"},"latency":{"type":"integer"}}}}}}}},"400":{"description":"Bad request or lookup failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Address parameter is required"}}}}}},"401":{"description":"Unauthorized - invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Invalid or missing API key"}}}}}},"402":{"description":"Insufficient credits","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Insufficient credits, add more https://apipie.ai/profile/subscribe"}}}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","example":"Property details lookup failed in Real Estate API"}}}}}}}}}}}