How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Haystack Openai API

The openai API from Haystack — 8 operation(s) for openai.

Haystack Openai API is one of 10 APIs that Haystack / deepset publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OpenAI. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 8 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.24.0.

Requests are made against the base URL http://localhost:1416.

8 operations 8 paths 13 schemas 2 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.24.0
Base URL
http://localhost:1416
Resource Areas
1

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 2 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

openai 8
GET
/models
List models
openai_models_alias → 200
GET
/v1/models
List models
openai_models → 200
POST
/chat/completions
Create chat completion
openai_chat_completions_alias body → 200500422
POST
/v1/chat/completions
Create chat completion
openai_chat_completions body → 200500422
POST
/responses
Create response
openai_responses_alias body → 200422
POST
/v1/responses
Create response
openai_responses body → 200422
POST
/files
Upload file
openai_files_create_alias body → 200500422
POST
/v1/files
Upload file
openai_files_create body → 200500422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ResponseRequest (18 properties), Response (9 properties), FileObject (7 properties), ChatCompletion (7 properties). Each schema is shown below with its type and property counts.

ResponseRequest
object
Incoming OpenAI Responses API request.
18 properties 1 required
Choice
object
A single choice in a chat completion response.
5 properties 1 required
Message
object
A single message in a chat completion response. Supports text content, tool calls, and safety refusals per the OpenAI spec.
5 properties 1 required
Body_openai_files_create
object
2 properties 2 required
Body_openai_files_create_alias
object
2 properties 2 required
ChatCompletion
object
Chat completion response, used for both full and streamed (chunk) responses.
7 properties 5 required
Response
object
Top-level OpenAI Responses API object.
9 properties 4 required
FileObject
object
OpenAI-compatible file object returned by the Files API.
7 properties 4 required
HTTPValidationError
object
1 property
ModelsResponse
object
Response schema for the OpenAI-compatible /v1/models endpoint.
2 properties 2 required
ModelObject
object
Represents a single model in the OpenAI /models response.
5 properties 5 required
ValidationError
object
5 properties 3 required
ChatRequest
object
Incoming chat completion request in OpenAI format. Any additional fields (e.g. temperature, maxtokens, topp, tools, toolchoice, responseformat) are accepted an…
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

haystack-openai-api-openapi.yml Raw ↑

Other APIs Haystack / deepset publishes across the network.

Haystack Framework (Open Source)
Hayhooks REST Deployment
Haystack / deepset Files API
Haystack / deepset Pipelines API
Haystack / deepset Search API
Haystack / deepset Workspaces API
Haystack Config API
Haystack Dashboard API
Haystack Status API
Where this information came from

This is an independent, third-party profile of Haystack Openai API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.