API reference
Embeddings
Endpoints, request fields and response schemas for calling NeonAPI.
POST /v1/embeddings
Authentication
Use your NeonAPI API key in Authorization: Bearer YOUR_API_KEY. Keep the key in a trusted application environment.
Availability and compatibility
Check the selected model’s protocol, permissions, price and supported parameters before calling. Unsupported parameters may be rejected. Request examples use placeholders.
Request fields
application/json
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
model | string | Yes | — | Exact published model ID. |
input | string / string[] | Yes | — | Input in the format required by this endpoint. |
encoding_format | string | No | float, base64; default: "float" | — |
dimensions | integer | No | — | — |
Full field definitions, nested objects and referenced schemas are available in the downloadable specification.
Request example
export NEON_API_KEY="YOUR_API_KEY"
curl https://neon-api.com/v1/embeddings \
-H "Authorization: Bearer $NEON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "YOUR_MODEL_ID",
"input": "Hello"
}'Responses
Fields vary by model and protocol. The schema below describes the documented successful response; streams use protocol-specific events.
| Status | Meaning |
|---|---|
| 200 | Successful response |
Response schema
| Field | Type | Required | Constraints | Meaning |
|---|---|---|---|---|
object | string | No | — | — |
data | object[] | No | — | Result items returned by this endpoint. |
model | string | No | — | Exact published model ID. |
usage | object | No | — | Usage reported by the selected protocol. |
Download the user API OpenAPI specification
See errors and streaming & tasks.