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

Portkey Prompts API

Given a prompt template ID and variables, will run the saved prompt template and return a response.

Portkey Prompts API is one of 51 APIs that Portkey publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 11 operations across 7 paths, and defines 39 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.portkey.ai/v1.

11 operations 7 paths 39 schemas 1 DELETE4 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.portkey.ai/v1
Authentication
API Key, API Key, HTTP Bearer, API Key, API Key, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 6

Portkey Prompts API declares 6 security schemes for authenticating requests. An API key is passed in the header as x-portkey-api-key (Portkey-Key). An API key is passed in the header as x-portkey-virtual-key (Virtual-Key). It accepts HTTP bearer tokens (Provider-Auth). An API key is passed in the header as x-portkey-provider (Provider-Name). An API key is passed in the header as x-portkey-config (Config). An API key is passed in the header as x-portkey-custom-host (Custom-Host). By default, every request must be authenticated.

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Prompts 11

Given a prompt template ID and variables, will run the saved prompt template and return a response.

POST
/prompts
Create a new prompt
createPrompt body → 200400401403500
GET
/prompts
List prompts
listPrompts 5 params → 200400401403500
GET
/prompts/{promptId}
Get a prompt by ID or slug
getPrompt 1 param → 200400401403404500
PUT
/prompts/{promptId}
Update a prompt
updatePrompt 1 param body → 200400401403404500
DELETE
/prompts/{promptId}
Delete a prompt
deletePrompt 1 param → 200400401403404500
GET
/prompts/{promptId}/versions
Get all versions of a prompt
getPromptVersions 1 param → 200400401403404500
GET
/prompts/{promptId}/versions/{versionId}
Get a specific version of a prompt
getPromptByVersion 2 params → 200400401403404500
PUT
/prompts/{promptId}/versions/{versionId}
Update a specific version of a prompt
updatePromptVersion 2 params body → 200400401403404500
PUT
/prompts/{promptId}/makeDefault
Set a version as the default for a prompt
updatePromptDefault 1 param body → 200400401403404500
POST
/prompts/{promptId}/completions
Prompts Completions
createPromptCompletion 1 param body → 200
POST
/prompts/{promptId}/render
Prompts Render
createPromptRender 1 param body → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are CreateChatCompletionRequest (24 properties), Prompt (21 properties), CreateCompletionRequest (18 properties), PromptVersionSummary (9 properties). Each schema is shown below with its type and property counts.

CreateChatCompletionRequest
object
24 properties 2 required
ResponseFormatText
object
Default response format. Used to generate text responses.
1 property 1 required
ChatCompletionRequestMessageContentPartText
object
2 properties 2 required
CreateChatCompletionResponse
object
Represents a chat completion response returned by model, based on the provided input.
7 properties 5 required
PromptVersionSummary
object
9 properties
ChatCompletionRequestFunctionMessage
object
3 properties 3 required
ResponseFormatJsonObject
object
JSON object response format. An older method of generating JSON responses. Using jsonschema is recommended for models that support it. Note that the model will…
1 property 1 required
ChatCompletionRequestSystemMessage
object
3 properties 2 required
ChatCompletionMessageToolCalls
array
The tool calls generated by the model, such as function calls.
ChatCompletionNamedToolChoice
object
Specifies a tool the model should use. Use to force the model to call a specific function.
2 properties 2 required
ChatCompletionRequestToolMessage
object
3 properties 3 required
CreateCompletionResponse
object
Represents a completion response from the API. Note: both the streamed and non-streamed response objects share the same shape (unlike the chat endpoint).
7 properties 5 required
CreateCompletionRequest
object
18 properties 2 required
ChatCompletionTool
object
2 properties 2 required
ResponseFormatJsonSchema
object
JSON Schema response format. Used to generate structured JSON responses. Learn more about [Structured Outputs](/docs/guides/structured-outputs).
2 properties 2 required
ChatCompletionStreamOptions
objectnull
Options for streaming response. Only set this when you set stream: true.
1 property
Prompt
object
21 properties
ChatCompletionRequestMessageContentPart
ChatCompletionToolChoiceOption
Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick…
ChatCompletionRequestAssistantMessage
object
5 properties 1 required
ChatCompletionResponseMessage
object
A chat completion message generated by the model.
5 properties 2 required
ChatCompletionRequestMessage
ChatCompletionRequestUserMessage
object
3 properties 2 required
ChatCompletionMessageContentBlock
object
A block of content in a chat completion message.
ChatCompletionMessageToolCall
object
3 properties 3 required
ParallelToolCalls
boolean
Whether to enable [parallel function calling](https://platform.openai.com/docs/guides/function-calling/parallel-function-calling) during tool use.
ChatCompletionFunctionCallOption
object
Specifying a particular function via {"name": "myfunction"} forces the model to call that function.
1 property 1 required
FunctionParameters
object
The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/function-calling) for examples…
ChatCompletionMessageContentPartRedactedThinking
object
2 properties 2 required
ChatCompletionRequestMessageContentPartImage
object
2 properties 2 required
ChatCompletionTokenLogprob
object
4 properties 4 required
CompletionUsage
object
Usage statistics for the completion request.
5 properties 3 required
FunctionObject
object
4 properties 1 required
ChatCompletionMessageContentPartThinking
object
2 properties 2 required
PromptRenderResponse
object
2 properties 2 required
PromptSummary
object
9 properties
ChatCompletionRequestDeveloperMessage
object
New role by OpenAI for select models. Must be explicitly used for models that support it. When used with incompatible models or providers, Portkey automaticall…
3 properties 2 required
ResponseFormatJsonSchemaSchema
object
The schema for the response format, described as a JSON Schema object. Learn how to build JSON schemas [here](https://json-schema.org/).
ChatCompletionFunctions
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portkey-prompts-api-openapi.yml Raw ↑

Other APIs Portkey publishes across the network.

Portkey Analytics > Graphs API
Portkey Analytics > Groups API
Portkey Analytics > Summary API
Portkey Api-Keys API
Portkey Assistants API
Portkey Audio API
Portkey Audit Logs API
Portkey Batch API
Portkey Chat API
Portkey Collections API
Portkey Completions API
Portkey Configs API
Where this information came from

This is an independent, third-party profile of Portkey Prompts 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.