POST /embeddings
Servers
- https://api.openai.com/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
dimensions |
Integer | No |
The number of dimensions the resulting output embeddings should have. Only supported in |
input |
Yes |
Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for |
|
user |
String | No |
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more. |
model |
Yes |
ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them. |
|
encoding_format |
String | No |
The format to return the embeddings in. Can be either Possible values:
Default value: "float" |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.