This guide will help you integrate PlanetZero API in your own program in 5 minutes.
\nGet your api-key
\nSet base_url
\nSend request
\nYou must use a valid API Key to send requests to the API endpoints. You can get your API key from dashboard.
\nThe API has no rate limits.
\nThe API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
\nThe API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.
\nThe API uses api-key for authentication. You can generate a Postman API key in the dashboard .
\nYou must include an API key in each request to the PlanetZero API endpoint with the Authorization request header.
\nIf an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.
\nIf your account does not have enough credits for this request, you will receive an HTTP 403 Unauthorized response code.
\nIn case you have questions, visit our FAQ page first. If you can't find a suitable solution, you can create a ticket in our discord server or through email: support@planetzeroapi.com .
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Get started here","slug":"get-started-here"}],"owner":"32238072","collectionId":"b3205cc4-1a3f-4c7e-a297-d374e59910d7","publishedId":"2sAYQdhotJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-01-21T19:35:29.000Z"},"item":[{"name":"OpenAI Compatiable Endpoint","item":[{"name":"Audio","item":[{"name":"Create speech","id":"acdaff5c-603a-4f74-abc8-448f063798f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer sk-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"model\": \"tts-1\",\r\n \"input\": \"The quick brown fox jumped over the lazy dog.\",\r\n \"voice\": \"alloy\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.planetzeroapi.com/v1/audio/speech","description":"This endpoint allows you to convert text to speech using the specified model and voice.
\nmodel (string): The model to be used for text-to-speech conversion.
input (string): The input text to be converted to speech.
voice (string): The voice to be used for the speech synthesis.
Example:
\n{\n \"model\": \"tts-1\",\n \"input\": \"The quick brown fox jumped over the lazy dog.\",\n \"voice\": \"alloy\"\n}\n\nThe audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
\n","type":"text"},{"key":"model","value":"whisper-1","description":"ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.
\n","type":"text"},{"key":"prompt","value":"eiusmod nulla","description":"An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language.
\n","type":"text"},{"key":"response_format","value":"json","description":"The format of the output, in one of these options: json, text, srt, verbose_json, or vtt.
\n","type":"text"},{"key":"temperature","value":"0","description":"The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.
\n","type":"text"},{"key":"language","value":"","description":"The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency.
\n","type":"text"}]},"url":"https://api.planetzeroapi.com/v1/audio/transcriptions","description":"This endpoint allows you to transcribe audio files using the specified model and parameters.
\nfile (text): The audio file object (not file name) to transcribe, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
model (text): ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.
prompt (text): An optional text to guide the model's style or continue a previous audio segment. The prompt should match the audio language.
response_format (text): The format of the output, in one of these options: json, text, srt, verbose_json, or vtt.
temperature (text): The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.
language (text): The language of the input audio. Supplying the input language in ISO-639-1 format will improve accuracy and latency.
The audio file object (not file name) translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
\n","type":"text"},{"key":"model","value":"whisper-1","description":"ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.
\n","type":"text"},{"key":"prompt","value":"","description":"An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English.
\n","type":"text"},{"key":"response_format","value":"json","description":"The format of the output, in one of these options: json, text, srt, verbose_json, or vtt.
\n","type":"text"},{"key":"temperature","value":"0","description":"The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.
\n","type":"text"}]},"url":"https://api.planetzeroapi.com/v1/audio/translations","description":"This endpoint is used to request audio translations using the specified parameters.
\nfile (text): The audio file object (not file name) to translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
model (text): ID of the model to use. Only whisper-1 (which is powered by our open source Whisper V2 model) is currently available.
prompt (text): An optional text to guide the model's style or continue a previous audio segment. The prompt should be in English.
response_format (text): The format of the output, in one of these options: json, text, srt, verbose_json, or vtt.
temperature (text): The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use log probability to automatically increase the temperature until certain thresholds are hit.
Learn how to turn audio into text or text into audio.
\n","_postman_id":"aa20327f-5fa7-40ab-893c-351fdc20c76b","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"773d1198-ece6-4a3a-835f-83f53952c2f8","id":"773d1198-ece6-4a3a-835f-83f53952c2f8","name":"OpenAI Compatiable Endpoint","type":"folder"}}},{"name":"Models","event":[{"listen":"test","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"176cb7e8-b59d-469d-b899-f85b29ffd414"}}],"id":"4fb4b1be-3b2e-46d6-a8ea-e97109c8ace9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer sk-xxx","type":"text"}],"url":"https://api.planetzeroapi.com/v1/models","description":"This endpoint retrieves information about all available models.
\nNo request body is required for this request.
\nMethod: GET
URL: https://api.cometapi.com/v1/models
The endpoint POST https://api.planetzeroapi.com/v1/chat/completions is used to send a request to generate chat completions. The request should include a model parameter specifying the model to use, a list of messages containing the role and content of the messages, and a stream parameter to indicate whether to stream the response.
model (string): Specifies the model to use for generating completions.
messages (array): Contains the role and content of the messages for which completions are to be generated.
role (string): Specifies the role of the message (e.g., \"user\", \"assistant\", \"system\").
content (string): The content of the message for which completions are to be generated.
stream (boolean): Indicates whether to stream the response.
This API endpoint allows you to generate embeddings for text using a specific model.
\nmodel (string, required): The name of the text embedding model to be used.
input (string, required): The input text for which embeddings need to be generated.
This API endpoint allows you to generate images based on the provided model, prompt, and other parameters.
\nmodel (string, required): The model to be used for image generation.
\nprompt (string, required): The prompt for image generation.
\nn (integer, required): The number of images to generate.
\nsize (string, required): The size of the generated image.
\nThis endpoint is used to create chat completions through the same format and parameters as Anthropic Claude. This endpoint only supports Claude models. Please view all supported models in Model List and Pricing
\n","urlObject":{"protocol":"https","path":["v1","messages"],"host":["api","planetzeroapi","com"],"query":[],"variable":[]}},"response":[{"id":"ba0e9c7a-b2b9-4c54-ad41-4318235d3bff","name":"Successful Response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"sk-xxx","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"model\": \"claude-3-5-sonnet-20240620\",\r\n \"max_tokens\": 1024,\r\n \"messages\": [\r\n {\r\n \"role\": \"user\",\r\n \"content\": \"Hello, world\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.planetzeroapi.com/v1/messages"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": \"chatcmpl-a1568ee22c7a4f31848f3dc16c2f3\",\r\n \"type\": \"message\",\r\n \"role\": \"assistant\",\r\n \"content\": [\r\n {\r\n \"type\": \"text\",\r\n \"text\": \"Hello! It's nice to meet you. I'm Claude, an AI assistant. How can I help you today? Feel free to ask me anything you'd like - I'm happy to assist with a wide range of topics and tasks.\"\r\n }\r\n ],\r\n \"model\": \"claude-3-5-sonnet-20240620\",\r\n \"stop_reason\": \"end_turn\",\r\n \"stop_sequence\": null,\r\n \"usage\": {\r\n \"input_tokens\": 3,\r\n \"output_tokens\": 52,\r\n \"cache_creation_input_tokens\": 0,\r\n \"cache_read_input_tokens\": 0\r\n }\r\n}"}],"_postman_id":"e179001a-53bf-4c21-a001-202911681d5e"}],"id":"92d71b9e-97db-44fd-a4fe-c5180221db26","description":"Support all Claude models
\n","_postman_id":"92d71b9e-97db-44fd-a4fe-c5180221db26"}],"event":[{"listen":"prerequest","script":{"id":"afdf101d-a8ef-48b4-9441-d99c1825f5ef","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ad49028d-f5c7-4c5b-a1d7-4374b1a356bd","type":"text/javascript","exec":[""]}}],"variable":[{"key":"api-key","value":"sk-xxx","type":"string"}]}