Skip to main content
POST
/
prompts
/
{promptId}
/
completions
curl -X POST "https://api.portkey.ai/v1/prompts/YOUR_PROMPT_ID/completions" \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -d '{
    "variables": {
      "user_input": "Hello world"
    },
    "max_tokens": 250,
    "presence_penalty": 0.2
  }'
{
  "status": "<string>",
  "headers": {},
  "body": {
    "id": "<string>",
    "choices": [
      {
        "finish_reason": "stop",
        "index": 123,
        "message": {
          "content": "<string>",
          "role": "assistant",
          "tool_calls": [
            {
              "id": "<string>",
              "type": "function",
              "function": {
                "name": "<string>",
                "arguments": "<string>"
              }
            }
          ],
          "function_call": {
            "arguments": "<string>",
            "name": "<string>"
          },
          "content_blocks": [
            {
              "type": "text",
              "text": "<string>"
            }
          ]
        },
        "logprobs": {
          "content": [
            {
              "token": "<string>",
              "logprob": 123,
              "bytes": [
                123
              ],
              "top_logprobs": [
                {
                  "token": "<string>",
                  "logprob": 123,
                  "bytes": [
                    123
                  ]
                }
              ]
            }
          ]
        }
      }
    ],
    "created": 123,
    "model": "<string>",
    "object": "chat.completion",
    "system_fingerprint": "<string>",
    "usage": {
      "completion_tokens": 123,
      "prompt_tokens": 123,
      "total_tokens": 123
    }
  }
}
Portkey Prompts API completely for both requests and responses, making it a drop-in replacement existing for your existing Chat or Completions calls.

​
Features

Create your Propmt Template on Portkey UI, define variables, and pass them with this API:
  • String Variables
  • JSON Variables
curl -X POST "https://api.portkey.ai/v1/prompts/YOUR_PROMPT_ID/completions" \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -d '{
    "variables": {
      "joke_topic": "elections",
      "humor_level": "10"
    }
  }'
You can override any model hyperparameter saved in the prompt template by sending its new value at the time of making a request:
curl -X POST "https://api.portkey.ai/v1/prompts/YOUR_PROMPT_ID/completions" \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -d '{
    "variables": {
      "user_input": "Hello world"
    },
    "temperature": 0.7,
    "max_tokens": 250,
    "presence_penalty": 0.2
  }'
Passing the {promptId} always calls the Published version of your prompt.But, you can also call a specific template version by appending its version number, like {promptId@12}:Version Tags:
  • @latest: Calls the
  • @{NUMBER} (like @12): Calls the specified version number
  • No Suffix: Here, Portkey defaults to the Published version
curl -X POST "https://api.portkey.ai/v1/prompts/PROMPT_ID@12/completions" \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -d '{
    "variables": {
      "user_input": "Hello world"
    }
  }'
Prompts API also supports streaming responses, and completely follows the OpenAI schema.
  • Set stream:True explicitly in your request to enable streaming
curl -X POST "https://api.portkey.ai/v1/prompts/YOUR_PROMPT_ID/completions" \
  -H "Content-Type: application/json" \
  -H "x-portkey-api-key: $PORTKEY_API_KEY" \
  -d '{
    "variables": {
      "user_input": "Hello world"
    },
    "stream": true
    "max_tokens": 250,
    "presence_penalty": 0.2
  }'

Authorizations

​
x-portkey-api-key
string
header
required

Path Parameters

​
promptId
string
required

The unique identifier of the prompt template to use

Body

application/json

Note: Although hyperparameters are shown grouped here (like messages, max_tokens, temperature, etc.), they should only be passed at the root level, alongside 'variables' and 'stream'.

​
variables
object
required

Variables to substitute in the prompt template

​
stream
boolean
default:false

Default: False. Set to True if you want to stream the response

​
hyperparameters
Chat Completions · object

Note: All hyperparameters are optional. Pass them at the root level, and not nested under hyperparameters. Their grouping here is for educational purposes only.

  • Chat Completions
  • Completions

Response

200 - application/json

Successful completion response

​
status
string

Response status

​
headers
object

Response headers

​
body
Chat Completions · object

Represents a chat completion response returned by model, based on the provided input.

  • Chat Completions
  • Completions