# Kling Text To Audio
Source: https://apidoc.deerapi.com/api/audio/kling/text-to-audio
/api/openapi/audio/kling/post-text-to-sfx.openapi.json POST /kling/v1/audio/text-to-audio
Use DeerAPI to call the Kling Text To Audio endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Text To Audio workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling TTS
Source: https://apidoc.deerapi.com/api/audio/kling/tts
/api/openapi/audio/kling/post-voice-tts.openapi.json POST /kling/v1/audio/tts
Use DeerAPI to call the Kling TTS endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling TTS workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Video To Audio
Source: https://apidoc.deerapi.com/api/audio/kling/video-to-audio
/api/openapi/audio/kling/post-video-to-sfx.openapi.json POST /kling/v1/audio/video-to-audio
Use DeerAPI to call the Kling Video To Audio endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Video To Audio workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# STT
Source: https://apidoc.deerapi.com/api/audio/openai/stt
/api/openapi/audio/openai/post-stt.openapi.json POST /v1/audio/transcriptions
Use DeerAPI to call the STT endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the STT workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Translation
Source: https://apidoc.deerapi.com/api/audio/openai/translation
/api/openapi/audio/openai/post-translation.openapi.json POST /v1/audio/translations
Use DeerAPI to call the Translation endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Translation workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# TTS
Source: https://apidoc.deerapi.com/api/audio/openai/tts
/api/openapi/audio/openai/post-tts.openapi.json POST /v1/audio/speech
Use DeerAPI to call the TTS endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the TTS workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Seedream Seededit
Source: https://apidoc.deerapi.com/api/image/doubao/seededit
/api/openapi/image/doubao/post-seededit.openapi.json POST /v1/images/edits
Use DeerAPI to call the Seedream Seededit endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Seedream Seededit workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Seedream Seedream
Source: https://apidoc.deerapi.com/api/image/doubao/seedream
/api/openapi/image/doubao/post-seedream.openapi.json POST /v1/images/generations
Use DeerAPI to call the Seedream Seedream endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Seedream Seedream workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# FLUX Create Task Replicate
Source: https://apidoc.deerapi.com/api/image/flux/create-task-replicate
/api/openapi/image/flux/post-create-task-replicate.openapi.json POST /replicate/v1/models/{models}/predictions
Use DeerAPI to call the FLUX Create Task Replicate endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the FLUX Create Task Replicate workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# FLUX Generate
Source: https://apidoc.deerapi.com/api/image/flux/generate
/api/openapi/image/flux/post-generate.openapi.json POST /flux/v1/{model}
Use DeerAPI to call the FLUX Generate endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the FLUX Generate workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# FLUX Query Task
Source: https://apidoc.deerapi.com/api/image/flux/query-task
/api/openapi/image/flux/get-query-task.openapi.json GET /flux/v1/get_result
Use DeerAPI to call the FLUX Query Task endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the FLUX Query Task workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Gemini Generate Image
Source: https://apidoc.deerapi.com/api/image/gemini/generate-image
/api/openapi/image/gemini/post-gemini-image.openapi.json POST /v1beta/models/{model}:generateContent
Use DeerAPI to call the Gemini Generate Image endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Gemini Generate Image workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Gemini Generate Image Guide
Source: https://apidoc.deerapi.com/api/image/gemini/generate-image-guide
Use DeerAPI to call the Gemini Generate Image Guide endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint when your application needs gemini generate image guide through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Expand
Source: https://apidoc.deerapi.com/api/image/kling/expand
/api/openapi/image/kling/post-expand-img.openapi.json POST /kling/v1/images/editing/expand
Use DeerAPI to call the Kling Expand endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Expand workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Generate
Source: https://apidoc.deerapi.com/api/image/kling/generate
/api/openapi/image/kling/post-image-gen.openapi.json POST /kling/v1/images/generations
Use DeerAPI to call the Kling Generate endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Generate workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Generate With References
Source: https://apidoc.deerapi.com/api/image/kling/generate-with-references
/api/openapi/image/kling/post-multi-img-gen.openapi.json POST /kling/v1/images/generations
Use DeerAPI to call the Kling Generate With References endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Generate With References workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Recognize
Source: https://apidoc.deerapi.com/api/image/kling/recognize
/api/openapi/image/kling/post-image-recognition.openapi.json POST /kling/v1/videos/image-recognize
Use DeerAPI to call the Kling Recognize endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Recognize workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Virtual Try On
Source: https://apidoc.deerapi.com/api/image/kling/virtual-try-on
/api/openapi/image/kling/post-virtual-try-on.openapi.json POST /kling/v1/images/kolors-virtual-try-on
Use DeerAPI to call the Kling Virtual Try On endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Virtual Try On workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Midjourney Quick Start
Source: https://apidoc.deerapi.com/api/image/midjourney/quick-start
Use DeerAPI to call the Midjourney Quick Start endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint when your application needs midjourney quick start through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Midjourney Submit Action
Source: https://apidoc.deerapi.com/api/image/midjourney/submit-action
/api/openapi/image/midjourney/post-submit-action.openapi.json POST /mj/submit/action
Use DeerAPI to call the Midjourney Submit Action endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Midjourney Submit Action workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Midjourney Submit Blend
Source: https://apidoc.deerapi.com/api/image/midjourney/submit-blend
/api/openapi/image/midjourney/post-submit-blend.openapi.json POST /mj/submit/blend
Use DeerAPI to call the Midjourney Submit Blend endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Midjourney Submit Blend workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Midjourney Submit Describe
Source: https://apidoc.deerapi.com/api/image/midjourney/submit-describe
/api/openapi/image/midjourney/post-submit-describe.openapi.json POST /mj/submit/describe
Use DeerAPI to call the Midjourney Submit Describe endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Midjourney Submit Describe workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Midjourney Submit Edit
Source: https://apidoc.deerapi.com/api/image/midjourney/submit-edit
/api/openapi/image/midjourney/post-submit-edit.openapi.json POST /mj/submit/edits
Use DeerAPI to call the Midjourney Submit Edit endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Midjourney Submit Edit workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Midjourney Submit Imagine
Source: https://apidoc.deerapi.com/api/image/midjourney/submit-imagine
/api/openapi/image/midjourney/post-submit-imagine.openapi.json POST /mj/submit/imagine
Use DeerAPI to call the Midjourney Submit Imagine endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Midjourney Submit Imagine workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Midjourney Submit Modal
Source: https://apidoc.deerapi.com/api/image/midjourney/submit-modal
/api/openapi/image/midjourney/post-submit-modal.openapi.json POST /mj/submit/modal
Use DeerAPI to call the Midjourney Submit Modal endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Midjourney Submit Modal workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Midjourney Submit Video
Source: https://apidoc.deerapi.com/api/image/midjourney/submit-video
/api/openapi/image/midjourney/post-submit-video.openapi.json POST /mj/submit/video
Use DeerAPI to call the Midjourney Submit Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Midjourney Submit Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Midjourney Get
Source: https://apidoc.deerapi.com/api/image/midjourney/tasks/get
/api/openapi/image/midjourney/tasks/get-get-by-id.openapi.json GET /mj/task/{id}/fetch
Use DeerAPI to call the Midjourney Get endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Midjourney Get workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Midjourney List
Source: https://apidoc.deerapi.com/api/image/midjourney/tasks/list
/api/openapi/image/midjourney/tasks/post-paginate.openapi.json POST /mj/task/list-by-condition
Use DeerAPI to call the Midjourney List endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Midjourney List workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Edit
Source: https://apidoc.deerapi.com/api/image/openai/edit
/api/openapi/image/openai/post-image-edit.openapi.json POST /v1/images/edits
Use DeerAPI to call the Edit endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Edit workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Generate
Source: https://apidoc.deerapi.com/api/image/openai/generate
/api/openapi/image/openai/post-images.openapi.json POST /v1/images/generations
Use DeerAPI to call the Generate endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Generate workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Replicate Create Task
Source: https://apidoc.deerapi.com/api/image/replicate/create-task
/api/openapi/image/replicate/post-create-task.openapi.json POST /replicate/v1/models/{models}/predictions
Use DeerAPI to call the Replicate Create Task endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Replicate Create Task workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Replicate Query Task
Source: https://apidoc.deerapi.com/api/image/replicate/query-task
/api/openapi/image/replicate/get-query-task.openapi.json GET /replicate/v1/predictions/{id}
Use DeerAPI to call the Replicate Query Task endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Replicate Query Task workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Custom Model
Source: https://apidoc.deerapi.com/api/music/suno/custom-model
/api/openapi/music/suno/post-custom-model.openapi.json POST /suno/custom-model
Use DeerAPI to call the Suno Custom Model endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Custom Model workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Custom Model Feed
Source: https://apidoc.deerapi.com/api/music/suno/custom-model-feed
/api/openapi/music/suno/get-custom-model-feed.openapi.json GET /suno/fetch/{model_id}
Use DeerAPI to call the Suno Custom Model Feed endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Custom Model Feed workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Expand Style Tags
Source: https://apidoc.deerapi.com/api/music/suno/expand-style-tags
/api/openapi/music/suno/post-expand-style-tags.openapi.json POST /suno/act/tags
Use DeerAPI to call the Suno Expand Style Tags endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Expand Style Tags workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Full Track Separate
Source: https://apidoc.deerapi.com/api/music/suno/full-track-separate
/api/openapi/music/suno/post-full-track-separate.openapi.json POST /suno/submit/music
Use DeerAPI to call the Suno Full Track Separate endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Full Track Separate workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Generate Lyrics
Source: https://apidoc.deerapi.com/api/music/suno/generate-lyrics
/api/openapi/music/suno/post-generate-lyrics.openapi.json POST /suno/submit/lyrics
Use DeerAPI to call the Suno Generate Lyrics endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Generate Lyrics workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Generate Music
Source: https://apidoc.deerapi.com/api/music/suno/generate-music
/api/openapi/music/suno/post-generate-music.openapi.json POST /suno/submit/music
Use DeerAPI to call the Suno Generate Music endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Generate Music workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Generate Mv
Source: https://apidoc.deerapi.com/api/music/suno/generate-mv
/api/openapi/music/suno/get-generate-mv.openapi.json GET /suno/act/mp4/{clip_id}
Use DeerAPI to call the Suno Generate Mv endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Generate Mv workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Get Midi
Source: https://apidoc.deerapi.com/api/music/suno/get-midi
/api/openapi/music/suno/get-get-midi.openapi.json GET /suno/act/midi/{clip_id}
Use DeerAPI to call the Suno Get Midi endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Get Midi workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Get Vox
Source: https://apidoc.deerapi.com/api/music/suno/get-vox
/api/openapi/music/suno/post-get-vox.openapi.json POST /suno/act/vox/{clip_id}
Use DeerAPI to call the Suno Get Vox endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Get Vox workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Get Wav
Source: https://apidoc.deerapi.com/api/music/suno/get-wav
/api/openapi/music/suno/get-get-wav.openapi.json GET /suno/act/wav/{clip_id}
Use DeerAPI to call the Suno Get Wav endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Get Wav workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Lyrics Mashup
Source: https://apidoc.deerapi.com/api/music/suno/lyrics-mashup
/api/openapi/music/suno/post-lyrics-mashup.openapi.json POST /suno/act/lyrics-mashup
Use DeerAPI to call the Suno Lyrics Mashup endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Lyrics Mashup workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Lyrics Timeline
Source: https://apidoc.deerapi.com/api/music/suno/lyrics-timeline
/api/openapi/music/suno/get-lyrics-timeline.openapi.json GET /suno/act/timing/{clip_id}
Use DeerAPI to call the Suno Lyrics Timeline endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Lyrics Timeline workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno New Persona
Source: https://apidoc.deerapi.com/api/music/suno/new-persona
/api/openapi/music/suno/post-new-persona.openapi.json POST /suno/persona/create
Use DeerAPI to call the Suno New Persona endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno New Persona workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Query Batch
Source: https://apidoc.deerapi.com/api/music/suno/query-batch
/api/openapi/music/suno/post-query-batch.openapi.json POST /suno/fetch
Use DeerAPI to call the Suno Query Batch endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Query Batch workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Query Single
Source: https://apidoc.deerapi.com/api/music/suno/query-single
/api/openapi/music/suno/get-query-single.openapi.json GET /suno/fetch/{task_id}
Use DeerAPI to call the Suno Query Single endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Query Single workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Set Version
Source: https://apidoc.deerapi.com/api/music/suno/set-version
Use DeerAPI to call the Suno Set Version endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint when your application needs suno set version through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Single Track Separate
Source: https://apidoc.deerapi.com/api/music/suno/single-track-separate
/api/openapi/music/suno/post-single-track-separate.openapi.json POST /suno/submit/music
Use DeerAPI to call the Suno Single Track Separate endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Single Track Separate workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Song Concat
Source: https://apidoc.deerapi.com/api/music/suno/song-concat
/api/openapi/music/suno/post-song-concat.openapi.json POST /suno/submit/concat
Use DeerAPI to call the Suno Song Concat endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Song Concat workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Suno API Guide
Source: https://apidoc.deerapi.com/api/music/suno/suno-api-guide
Use DeerAPI to call the Suno Suno API Guide endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint when your application needs suno suno api guide through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Upload Music
Source: https://apidoc.deerapi.com/api/music/suno/upload-music
/api/openapi/music/suno/post-upload-music.openapi.json POST /suno/uploads/audio-url
Use DeerAPI to call the Suno Upload Music endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Upload Music workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Voice Create
Source: https://apidoc.deerapi.com/api/music/suno/voice-create
/api/openapi/music/suno/post-voice-create.openapi.json POST /suno/persona/voice/create
Use DeerAPI to call the Suno Voice Create endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Voice Create workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Voice Phrase
Source: https://apidoc.deerapi.com/api/music/suno/voice-phrase
/api/openapi/music/suno/post-voice-phrase.openapi.json POST /suno/act/phrase
Use DeerAPI to call the Suno Voice Phrase endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Voice Phrase workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Voice Verify
Source: https://apidoc.deerapi.com/api/music/suno/voice-verify
/api/openapi/music/suno/post-voice-verify.openapi.json POST /suno/persona/voice/verify
Use DeerAPI to call the Suno Voice Verify endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Voice Verify workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Suno Voice Vox
Source: https://apidoc.deerapi.com/api/music/suno/voice-vox
/api/openapi/music/suno/post-voice-vox.openapi.json POST /suno/persona/voice/vox
Use DeerAPI to call the Suno Voice Vox endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Suno Voice Vox workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Anthropic Messages
Source: https://apidoc.deerapi.com/api/text/anthropic/messages
/api/openapi/text/anthropic/post-anthropic-messages.openapi.json POST /v1/messages
Use DeerAPI to call the Anthropic Messages endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Anthropic Messages workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Gemini Generate Content
Source: https://apidoc.deerapi.com/api/text/gemini/generate-content
/api/openapi/text/gemini/post-gemini-text.openapi.json POST /v1beta/models/{model}:{function}
Use DeerAPI to call the Gemini Generate Content endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Gemini Generate Content workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Chat
Source: https://apidoc.deerapi.com/api/text/openai/chat
/api/openapi/text/openai/post-chat.openapi.json POST /v1/chat/completions
Use DeerAPI to call the Chat endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Chat workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Embeddings
Source: https://apidoc.deerapi.com/api/text/openai/embeddings
/api/openapi/text/openai/post-embeddings.openapi.json POST /v1/embeddings
Use DeerAPI to call the Embeddings endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Embeddings workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Models
Source: https://apidoc.deerapi.com/api/text/openai/models
/api/openapi/text/openai/get-models.openapi.json GET /v1/models
Use DeerAPI to call the Models endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Models workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Responses
Source: https://apidoc.deerapi.com/api/text/openai/responses
/api/openapi/text/openai/post-responses.openapi.json POST /v1/responses
Use DeerAPI to call the Responses endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Responses workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Avatar Create
Source: https://apidoc.deerapi.com/api/video/kling/avatar-create
/api/openapi/video/kling/post-avatar-create.openapi.json POST /kling/v1/videos/avatar/image2video
Use DeerAPI to call the Kling Avatar Create endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Avatar Create workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Callback
Source: https://apidoc.deerapi.com/api/video/kling/callback
Use DeerAPI to call the Kling Callback endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint when your application needs kling callback through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Extend Video
Source: https://apidoc.deerapi.com/api/video/kling/extend-video
/api/openapi/video/kling/post-extend-video.openapi.json POST /kling/v1/videos/video-extend
Use DeerAPI to call the Kling Extend Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Extend Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Image To Video
Source: https://apidoc.deerapi.com/api/video/kling/image-to-video
/api/openapi/video/kling/post-image-to-video.openapi.json POST /kling/v1/videos/image2video
Use DeerAPI to call the Kling Image To Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Image To Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Lipsync Create
Source: https://apidoc.deerapi.com/api/video/kling/lipsync-create
/api/openapi/video/kling/post-lipsync-create.openapi.json POST /kling/v1/videos/advanced-lip-sync
Use DeerAPI to call the Kling Lipsync Create endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Lipsync Create workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Lipsync Face
Source: https://apidoc.deerapi.com/api/video/kling/lipsync-face
/api/openapi/video/kling/post-lipsync-face.openapi.json POST /kling/v1/videos/identify-face
Use DeerAPI to call the Kling Lipsync Face endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Lipsync Face workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Multi Image To Video
Source: https://apidoc.deerapi.com/api/video/kling/multi-image-to-video
/api/openapi/video/kling/post-multi-img-to-video.openapi.json POST /kling/v1/videos/multi-image2video
Use DeerAPI to call the Kling Multi Image To Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Multi Image To Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Add Mask
Source: https://apidoc.deerapi.com/api/video/kling/multimodal-edit/add-mask
/api/openapi/video/kling/multimodal-edit/post-add-mask.openapi.json POST /kling/v1/videos/multi-elements/add-selection
Use DeerAPI to call the Kling Add Mask endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Add Mask workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Clear Mask
Source: https://apidoc.deerapi.com/api/video/kling/multimodal-edit/clear-mask
/api/openapi/video/kling/multimodal-edit/post-clear-mask.openapi.json POST /kling/v1/videos/multi-elements/clear-selection
Use DeerAPI to call the Kling Clear Mask endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Clear Mask workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Create Task
Source: https://apidoc.deerapi.com/api/video/kling/multimodal-edit/create-task
/api/openapi/video/kling/multimodal-edit/post-create-task.openapi.json POST /kling/v1/videos/multi-elements
Use DeerAPI to call the Kling Create Task endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Create Task workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Init Video
Source: https://apidoc.deerapi.com/api/video/kling/multimodal-edit/init-video
/api/openapi/video/kling/multimodal-edit/post-init-video.openapi.json POST /kling/v1/videos/multi-elements/init-selection
Use DeerAPI to call the Kling Init Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Init Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Preview Mask
Source: https://apidoc.deerapi.com/api/video/kling/multimodal-edit/preview-mask
/api/openapi/video/kling/multimodal-edit/post-preview-mask.openapi.json POST /kling/v1/videos/multi-elements/preview-selection
Use DeerAPI to call the Kling Preview Mask endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Preview Mask workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Remove Mask
Source: https://apidoc.deerapi.com/api/video/kling/multimodal-edit/remove-mask
/api/openapi/video/kling/multimodal-edit/post-remove-mask.openapi.json POST /kling/v1/videos/multi-elements/delete-selection
Use DeerAPI to call the Kling Remove Mask endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Remove Mask workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Omni Query
Source: https://apidoc.deerapi.com/api/video/kling/omni-query
/api/openapi/video/kling/get-omni-query.openapi.json GET /kling/v1/videos/omni-video/{task_id}
Use DeerAPI to call the Kling Omni Query endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Omni Query workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Omni Video
Source: https://apidoc.deerapi.com/api/video/kling/omni-video
/api/openapi/video/kling/post-omni-video.openapi.json POST /kling/v1/videos/omni-video
Use DeerAPI to call the Kling Omni Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Omni Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Query Task
Source: https://apidoc.deerapi.com/api/video/kling/query-task
/api/openapi/video/kling/get-query-task.openapi.json GET /kling/v1/{action}/{action2}/{task_id}
Use DeerAPI to call the Kling Query Task endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Query Task workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Text To Video
Source: https://apidoc.deerapi.com/api/video/kling/text-to-video
/api/openapi/video/kling/post-text-to-video.openapi.json POST /kling/v1/videos/text2video
Use DeerAPI to call the Kling Text To Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Text To Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Kling Video Effects
Source: https://apidoc.deerapi.com/api/video/kling/video-effects
/api/openapi/video/kling/post-video-effects.openapi.json POST /kling/v1/videos/effects
Use DeerAPI to call the Kling Video Effects endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Kling Video Effects workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Runway Act One
Source: https://apidoc.deerapi.com/api/video/runway/compat/act-one
/api/openapi/video/runway/compat/post-act-one.openapi.json POST /runway/pro/act_one
Use DeerAPI to call the Runway Act One endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Runway Act One workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Runway Feed
Source: https://apidoc.deerapi.com/api/video/runway/compat/feed
/api/openapi/video/runway/compat/post-feed.openapi.json POST /runway/feed
Use DeerAPI to call the Runway Feed endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Runway Feed workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Runway Generate
Source: https://apidoc.deerapi.com/api/video/runway/compat/generate
/api/openapi/video/runway/compat/post-generate.openapi.json POST /runway/pro/generate
Use DeerAPI to call the Runway Generate endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Runway Generate workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Runway Image To Video
Source: https://apidoc.deerapi.com/api/video/runway/compat/image-to-video
/api/openapi/video/runway/compat/post-image-to-video.openapi.json POST /runway/pro/generate
Use DeerAPI to call the Runway Image To Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Runway Image To Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Runway Video2video
Source: https://apidoc.deerapi.com/api/video/runway/compat/video2video
/api/openapi/video/runway/compat/post-video2video.openapi.json POST /runway/pro/video2video
Use DeerAPI to call the Runway Video2video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Runway Video2video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Runway Image To Video
Source: https://apidoc.deerapi.com/api/video/runway/official/image-to-video
/api/openapi/video/runway/official/post-image-to-video.openapi.json POST /runwayml/v1/image_to_video
Use DeerAPI to call the Runway Image To Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Runway Image To Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Runway Task Details
Source: https://apidoc.deerapi.com/api/video/runway/official/task-details
/api/openapi/video/runway/official/get-task-details.openapi.json GET /runwayml/v1/tasks/{id}
Use DeerAPI to call the Runway Task Details endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Runway Task Details workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Sora 2 Create Video
Source: https://apidoc.deerapi.com/api/video/sora-2/official/create-video
/api/openapi/video/sora-2/official/post-create-video.openapi.json POST /v1/videos
Use DeerAPI to call the Sora 2 Create Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Sora 2 Create Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Sora 2 Download Video
Source: https://apidoc.deerapi.com/api/video/sora-2/official/download-video
/api/openapi/video/sora-2/official/get-download-video.openapi.json GET /v1/videos/{video_id}/content
Use DeerAPI to call the Sora 2 Download Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Sora 2 Download Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Sora 2 Remix Video
Source: https://apidoc.deerapi.com/api/video/sora-2/official/remix-video
/api/openapi/video/sora-2/official/post-remix-video.openapi.json POST /v1/videos/{video_id}/remix
Use DeerAPI to call the Sora 2 Remix Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Sora 2 Remix Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Sora 2 Search Video
Source: https://apidoc.deerapi.com/api/video/sora-2/official/search-video
/api/openapi/video/sora-2/official/get-search-video.openapi.json GET /v1/videos/{video_id}
Use DeerAPI to call the Sora 2 Search Video endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Sora 2 Search Video workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Veo 3 Create
Source: https://apidoc.deerapi.com/api/video/veo3/async/create
/api/openapi/video/veo3/async/post-veo3-async.openapi.json POST /v1/videos
Use DeerAPI to call the Veo 3 Create endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Veo 3 Create workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Veo 3 Query
Source: https://apidoc.deerapi.com/api/video/veo3/async/query
/api/openapi/video/veo3/async/get-veo3-query.openapi.json GET /v1/videos/{video_id}
Use DeerAPI to call the Veo 3 Query endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Veo 3 Query workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Veo 3 Chat
Source: https://apidoc.deerapi.com/api/video/veo3/chat
/api/openapi/video/veo3/post-veo3-chat.openapi.json POST /v1/chat/completions
Use DeerAPI to call the Veo 3 Chat endpoint with request details, response details, examples, and an OpenAPI playground.
## Overview
Use this endpoint to call the Veo 3 Chat workflow through DeerAPI. The API reference on this page shows the request schema, response schema, authentication requirements, and runnable examples for the configured endpoint.
## Before you start
Use the DeerAPI base URL and pass your API Key in the `Authorization` header:
```text theme={null}
https://api.deerapi.com
```
```text theme={null}
Authorization: Bearer $DEERAPI_KEY
```
## Model selection
Choose a current model ID from the [live pricing page](https://api.deerapi.com/pricing). Model availability changes over time, so avoid copying a model ID from an old project without checking the live list first.
## Implementation notes
* Use the OpenAPI playground for the exact request fields accepted by this endpoint.
* Keep API Keys on the server side when you build production applications.
* Log the request ID from failed calls so support can investigate the request.
* Retry `429`, `500`, and `503` responses with exponential backoff.
# Common Mistakes
Source: https://apidoc.deerapi.com/help/common-mistakes
DeerAPI common mistakes reference for API setup, billing, privacy, support, and troubleshooting.
## Overview
This page explains common mistakes for DeerAPI users. Use it to verify configuration, understand expected behavior, and decide what to check before contacting support.
## Recommended checks
* Confirm that your base URL is `https://api.deerapi.com/v1` for OpenAI-compatible SDKs.
* Confirm that your request uses `Authorization: Bearer $DEERAPI_KEY`.
* Confirm that the model ID appears on the [live pricing page](https://api.deerapi.com/pricing).
* Keep request IDs from failed calls for troubleshooting.
## Production guidance
Use retries with exponential backoff for transient failures, monitor usage in the dashboard, and rotate API Keys after exposure.
# Error Codes and Troubleshooting
Source: https://apidoc.deerapi.com/help/error-codes
DeerAPI error codes and troubleshooting reference for API setup, billing, privacy, support, and troubleshooting.
## Overview
This page explains error codes and troubleshooting for DeerAPI users. Use it to verify configuration, understand expected behavior, and decide what to check before contacting support.
## Recommended checks
* Confirm that your base URL is `https://api.deerapi.com/v1` for OpenAI-compatible SDKs.
* Confirm that your request uses `Authorization: Bearer $DEERAPI_KEY`.
* Confirm that the model ID appears on the [live pricing page](https://api.deerapi.com/pricing).
* Keep request IDs from failed calls for troubleshooting.
## Production guidance
Use retries with exponential backoff for transient failures, monitor usage in the dashboard, and rotate API Keys after exposure.
# Usage FAQ
Source: https://apidoc.deerapi.com/help/faq
DeerAPI usage faq reference for API setup, billing, privacy, support, and troubleshooting.
## Overview
This page explains usage faq for DeerAPI users. Use it to verify configuration, understand expected behavior, and decide what to check before contacting support.
## Recommended checks
* Confirm that your base URL is `https://api.deerapi.com/v1` for OpenAI-compatible SDKs.
* Confirm that your request uses `Authorization: Bearer $DEERAPI_KEY`.
* Confirm that the model ID appears on the [live pricing page](https://api.deerapi.com/pricing).
* Keep request IDs from failed calls for troubleshooting.
## Production guidance
Use retries with exponential backoff for transient failures, monitor usage in the dashboard, and rotate API Keys after exposure.
# Help Center
Source: https://apidoc.deerapi.com/help/overview
DeerAPI help center reference for API setup, billing, privacy, support, and troubleshooting.
## Overview
The DeerAPI help center covers setup, billing, troubleshooting, privacy, and support workflows for production API usage.
## Core links
* Use the [Quick Start](/quick-start/quick-start) to make your first API call.
* Use [Common Mistakes](/help/common-mistakes) to diagnose base URL, API Key, and model ID issues.
* Use [Error Codes and Troubleshooting](/help/error-codes) to handle failed requests.
* Use the [live pricing page](https://api.deerapi.com/pricing) to choose model IDs and review costs.
## Support
When you contact support, include the affected request ID, endpoint, model ID, and approximate request time. Do not send your API Key or private request content.
# Privacy Policy
Source: https://apidoc.deerapi.com/help/privacy
DeerAPI privacy policy reference for API setup, billing, privacy, support, and troubleshooting.
## Overview
DeerAPI is designed to route API requests while limiting the data that is stored for routine service operation.
## Request content
DeerAPI does not use customer prompt or completion content to train models. Operational logs may include metadata such as request time, request ID, endpoint, model ID, status code, token usage, IP address, and account usage.
## Account information
DeerAPI may collect account details that you provide, such as email address, login provider identifiers, billing records, and support messages. This information is used to operate the service, prevent abuse, and respond to support requests.
## Security
Keep API Keys private. Store keys in server-side environment variables or a secrets manager, and rotate keys after exposure. No internet service can guarantee absolute security, but DeerAPI applies access controls and operational safeguards to protect service data.
## Third-party providers
Requests may be processed by model providers that power the selected model. Review the provider terms that apply to the models that you use.
# API Stability
Source: https://apidoc.deerapi.com/help/stability
DeerAPI api stability reference for API setup, billing, privacy, support, and troubleshooting.
## Overview
This page explains api stability for DeerAPI users. Use it to verify configuration, understand expected behavior, and decide what to check before contacting support.
## Recommended checks
* Confirm that your base URL is `https://api.deerapi.com/v1` for OpenAI-compatible SDKs.
* Confirm that your request uses `Authorization: Bearer $DEERAPI_KEY`.
* Confirm that the model ID appears on the [live pricing page](https://api.deerapi.com/pricing).
* Keep request IDs from failed calls for troubleshooting.
## Production guidance
Use retries with exponential backoff for transient failures, monitor usage in the dashboard, and rotate API Keys after exposure.
# Terms of Service
Source: https://apidoc.deerapi.com/help/terms
DeerAPI terms of service reference for API setup, billing, privacy, support, and troubleshooting.
## Overview
These terms describe acceptable use of DeerAPI documentation and API services. By using DeerAPI, you agree to use the service responsibly and comply with applicable laws and provider terms.
## Acceptable use
Do not use DeerAPI to abuse, disrupt, probe, or overload the service. Do not share API Keys publicly, resell access in a way that violates provider terms, or send content that you are not authorized to process.
## Billing and credits
Usage is billed according to the dashboard, selected model, and live pricing page. Review usage logs regularly and disable exposed API Keys immediately.
## Availability
DeerAPI is designed for production use, but API availability can vary by model provider, route, and account state. Build retry logic and fallback behavior into production clients.
## Support
For account or billing questions, contact support from the DeerAPI dashboard and include the relevant request ID or transaction reference.
# Use DeerAPI with Anythingllm
Source: https://apidoc.deerapi.com/integration/anythingllm
Connect Anythingllm to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Anythingllm to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Anythingllm can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Anythingllm application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Anythingllm
In Anythingllm, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Anythingllm. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Avante Nvim
Source: https://apidoc.deerapi.com/integration/avante-nvim
Connect Avante Nvim to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Avante Nvim to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Avante Nvim can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Avante Nvim application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Avante Nvim
In Avante Nvim, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Avante Nvim. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Balance API
Source: https://apidoc.deerapi.com/integration/best-practices/balance-api
Connect Balance API to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Balance API to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Balance API can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Balance API application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Balance API
In Balance API, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Balance API. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Midjourney Best Practices
Source: https://apidoc.deerapi.com/integration/best-practices/midjourney-best-practices
Connect Midjourney Best Practices to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Midjourney Best Practices to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Midjourney Best Practices can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Midjourney Best Practices application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Midjourney Best Practices
In Midjourney Best Practices, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Midjourney Best Practices. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Retry Logic
Source: https://apidoc.deerapi.com/integration/best-practices/retry-logic
Connect Retry Logic to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Retry Logic to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Retry Logic can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Retry Logic application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Retry Logic
In Retry Logic, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Retry Logic. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Runway Best Practices
Source: https://apidoc.deerapi.com/integration/best-practices/runway-best-practices
Connect Runway Best Practices to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Runway Best Practices to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Runway Best Practices can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Runway Best Practices application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Runway Best Practices
In Runway Best Practices, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Runway Best Practices. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Chatall
Source: https://apidoc.deerapi.com/integration/chatall
Connect Chatall to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Chatall to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Chatall can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Chatall application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Chatall
In Chatall, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Chatall. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Chatbox
Source: https://apidoc.deerapi.com/integration/chatbox
Connect Chatbox to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Chatbox to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Chatbox can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Chatbox application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Chatbox
In Chatbox, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Chatbox. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Chathub
Source: https://apidoc.deerapi.com/integration/chathub
Connect Chathub to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Chathub to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Chathub can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Chathub application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Chathub
In Chathub, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Chathub. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Cherrystudio
Source: https://apidoc.deerapi.com/integration/cherrystudio
Connect Cherrystudio to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Cherrystudio to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Cherrystudio can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Cherrystudio application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Cherrystudio
In Cherrystudio, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Cherrystudio. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Claude Code
Source: https://apidoc.deerapi.com/integration/claude-code
Connect Claude Code to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Claude Code to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Claude Code can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Claude Code application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Claude Code
In Claude Code, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Claude Code. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Claude Desktop
Source: https://apidoc.deerapi.com/integration/claude-desktop
Connect Claude Desktop to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Claude Desktop to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Claude Desktop can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Claude Desktop application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Claude Desktop
In Claude Desktop, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Claude Desktop. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Cline
Source: https://apidoc.deerapi.com/integration/cline
Connect Cline to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Cline to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Cline can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Cline application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Cline
In Cline, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Cline. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Codex
Source: https://apidoc.deerapi.com/integration/codex
Connect Codex to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Codex to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Codex can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Codex application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Codex
In Codex, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Codex. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Coze
Source: https://apidoc.deerapi.com/integration/coze
Connect Coze to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Coze to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Coze can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Coze application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Coze
In Coze, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Coze. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with DeerAPI
Source: https://apidoc.deerapi.com/integration/deerapi
Connect DeerAPI to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect DeerAPI to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, DeerAPI can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The DeerAPI application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure DeerAPI
In DeerAPI, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from DeerAPI. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Dify
Source: https://apidoc.deerapi.com/integration/dify
Connect Dify to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Dify to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Dify can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Dify application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Dify
In Dify, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Dify. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Fastgpt
Source: https://apidoc.deerapi.com/integration/fastgpt
Connect Fastgpt to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Fastgpt to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Fastgpt can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Fastgpt application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Fastgpt
In Fastgpt, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Fastgpt. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with GPT Academic
Source: https://apidoc.deerapi.com/integration/gpt-academic
Connect GPT Academic to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect GPT Academic to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, GPT Academic can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The GPT Academic application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure GPT Academic
In GPT Academic, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from GPT Academic. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Gptme
Source: https://apidoc.deerapi.com/integration/gptme
Connect Gptme to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Gptme to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Gptme can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Gptme application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Gptme
In Gptme, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Gptme. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Hermes Agent
Source: https://apidoc.deerapi.com/integration/hermes-agent
Connect Hermes Agent to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Hermes Agent to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Hermes Agent can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Hermes Agent application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Hermes Agent
In Hermes Agent, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Hermes Agent. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Immersive Translate
Source: https://apidoc.deerapi.com/integration/immersive-translate
Connect Immersive Translate to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Immersive Translate to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Immersive Translate can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Immersive Translate application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Immersive Translate
In Immersive Translate, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Immersive Translate. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Intellij Translation Plugin
Source: https://apidoc.deerapi.com/integration/intellij-translation-plugin
Connect Intellij Translation Plugin to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Intellij Translation Plugin to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Intellij Translation Plugin can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Intellij Translation Plugin application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Intellij Translation Plugin
In Intellij Translation Plugin, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Intellij Translation Plugin. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Langchain
Source: https://apidoc.deerapi.com/integration/langchain
Connect Langchain to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Langchain to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Langchain can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Langchain application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Langchain
In Langchain, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Langchain. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Lazy Service
Source: https://apidoc.deerapi.com/integration/lazy-service
Connect Lazy Service to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Lazy Service to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Lazy Service can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Lazy Service application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Lazy Service
In Lazy Service, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Lazy Service. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Librechat
Source: https://apidoc.deerapi.com/integration/librechat
Connect Librechat to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Librechat to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Librechat can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Librechat application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Librechat
In Librechat, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Librechat. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Lobe Chat
Source: https://apidoc.deerapi.com/integration/lobe-chat
Connect Lobe Chat to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Lobe Chat to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Lobe Chat can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Lobe Chat application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Lobe Chat
In Lobe Chat, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Lobe Chat. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Next Chat
Source: https://apidoc.deerapi.com/integration/next-chat
Connect Next Chat to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Next Chat to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Next Chat can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Next Chat application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Next Chat
In Next Chat, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Next Chat. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Obsidian Text Gen
Source: https://apidoc.deerapi.com/integration/obsidian-text-gen
Connect Obsidian Text Gen to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Obsidian Text Gen to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Obsidian Text Gen can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Obsidian Text Gen application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Obsidian Text Gen
In Obsidian Text Gen, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Obsidian Text Gen. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Open Webui
Source: https://apidoc.deerapi.com/integration/open-webui
Connect Open Webui to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Open Webui to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Open Webui can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Open Webui application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Open Webui
In Open Webui, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Open Webui. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with OpenAI Translator
Source: https://apidoc.deerapi.com/integration/openai-translator
Connect OpenAI Translator to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect OpenAI Translator to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, OpenAI Translator can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The OpenAI Translator application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure OpenAI Translator
In OpenAI Translator, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from OpenAI Translator. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Openclaw
Source: https://apidoc.deerapi.com/integration/openclaw
Connect Openclaw to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Openclaw to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Openclaw can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Openclaw application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Openclaw
In Openclaw, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Openclaw. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Ouluyi
Source: https://apidoc.deerapi.com/integration/ouluyi
Connect Ouluyi to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Ouluyi to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Ouluyi can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Ouluyi application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Ouluyi
In Ouluyi, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Ouluyi. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Pot Translate
Source: https://apidoc.deerapi.com/integration/pot-translate
Connect Pot Translate to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Pot Translate to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Pot Translate can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Pot Translate application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Pot Translate
In Pot Translate, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Pot Translate. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Stranslate
Source: https://apidoc.deerapi.com/integration/stranslate
Connect Stranslate to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Stranslate to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Stranslate can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Stranslate application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Stranslate
In Stranslate, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Stranslate. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Utools Chatgpt
Source: https://apidoc.deerapi.com/integration/utools-chatgpt
Connect Utools Chatgpt to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Utools Chatgpt to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Utools Chatgpt can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Utools Chatgpt application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Utools Chatgpt
In Utools Chatgpt, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Utools Chatgpt. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Use DeerAPI with Zotero
Source: https://apidoc.deerapi.com/integration/zotero
Connect Zotero to DeerAPI with an OpenAI-compatible base URL, API Key, and current model ID.
## Overview
Use this guide to connect Zotero to DeerAPI with an OpenAI-compatible base URL and a DeerAPI API Key. After configuration, Zotero can call any model that is available on the live DeerAPI pricing page.
## Prerequisites
* A DeerAPI account.
* A DeerAPI API Key.
* The Zotero application installed or accessible in your workspace.
* A current model ID from the [live pricing page](https://api.deerapi.com/pricing).
## Configure Zotero
In Zotero, open the settings area for custom OpenAI-compatible providers.
Enter `https://api.deerapi.com/v1` as the base URL. If the tool asks for a host without the version suffix, use `https://api.deerapi.com`.
Paste your DeerAPI API key in the API key field.
Add or select a model ID from the live pricing page, then save the provider configuration.
Send a short prompt from Zotero. A successful response confirms that the base URL, API Key, and model ID are configured correctly.
## Troubleshooting
* If the tool returns `401`, create a new API Key and update the saved provider configuration.
* If the tool returns `404`, check whether the base URL expects `/v1`.
* If the tool cannot find the model, verify the model ID on the live pricing page.
* If requests fail intermittently, enable retries in the client or reduce parallel requests.
# Billing Groups
Source: https://apidoc.deerapi.com/pricing/groups
DeerAPI billing groups guide for live model pricing, usage-based billing, credits, and cost review.
## Overview
Billing groups help you organize usage by project, environment, or team. Use groups when you need separate tracking for production, staging, customer projects, or internal teams.
## Recommended usage
* Create one group per cost center or application.
* Assign API Keys to the group that owns the traffic.
* Review usage logs before changing a production group's settings.
* Keep a default group for experiments and short-lived tests.
## Cost review
Use the DeerAPI dashboard and the [live pricing page](https://api.deerapi.com/pricing) to review model prices and usage. Model pricing can differ by provider, model family, and request type.
# Pricing Overview
Source: https://apidoc.deerapi.com/pricing/overview
DeerAPI pricing overview guide for live model pricing, usage-based billing, credits, and cost review.
## Overview
DeerAPI uses usage-based billing. Costs depend on the selected model, request type, input size, output size, and provider pricing rules.
## Review live pricing
Use the [live pricing page](https://api.deerapi.com/pricing) as the source of truth for model availability and pricing. Avoid hardcoding old prices in applications or internal runbooks.
## Cost controls
* Choose the smallest model that meets the quality requirement.
* Set client-side limits for tokens, image counts, video duration, and concurrency.
* Monitor usage logs after deployment.
* Rotate API Keys and disable unused keys.
## Billing questions
For account-specific billing questions, contact support from the DeerAPI dashboard and include the transaction or request reference.
# Getting Started FAQ
Source: https://apidoc.deerapi.com/quick-start/intro
DeerAPI getting started faq guide.
## What is DeerAPI?
DeerAPI provides one API account for text, image, video, audio, and music models. Many endpoints are compatible with OpenAI SDK patterns, so most integrations only require a DeerAPI API Key and a base URL change.
## Get an API Key
1. Open the [DeerAPI dashboard](https://api.deerapi.com/panel).
2. Create an API Key from the API Key page.
3. Store the API Key in a server-side environment variable.
## Choose a model
Use the [live pricing page](https://api.deerapi.com/pricing) to choose a current model ID. Pass that value in the `model` field for compatible endpoints.
## Use the right base URL
For OpenAI-compatible SDKs, start with this base URL:
```text theme={null}
https://api.deerapi.com/v1
```
If a third-party tool asks for a host without a version suffix, use `https://api.deerapi.com`.
## Review usage
Use the DeerAPI dashboard to review request logs, token usage, model usage, and billing details.
# Quick Start
Source: https://apidoc.deerapi.com/quick-start/quick-start
DeerAPI quick start guide.
## 30-second switch from OpenAI
Use this two-setting diff when you switch an OpenAI SDK client to DeerAPI:
```diff theme={null}
- base_url="https://api.openai.com/v1"
- api_key=os.environ["OPENAI_API_KEY"]
+ base_url="https://api.deerapi.com/v1"
+ api_key=os.environ["DEERAPI_KEY"]
```
## Make your first call
The following example sends a chat completion request:
```bash theme={null}
curl https://api.deerapi.com/v1/chat/completions \
-H "Authorization: Bearer $DEERAPI_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "your-model-id",
"messages": [
{"role": "user", "content": "Write a one-sentence product tagline."}
]
}'
```
## Next steps
* Choose a model ID from the [live pricing page](https://api.deerapi.com/pricing).
* Read [Chat Completions](/api/text/openai/chat) for OpenAI-compatible text calls.
* Read [Common Mistakes](/help/common-mistakes) if a tool returns `401`, `404`, or a model-not-found error.