Rest API

Open AI
For OpenAI, change the API basepath according to the OpenAI endpoint you are calling, and add the x-portkey-api-key & x-portkey-mode headers. Mode value for OpenAI should proxy openai
Replace <PORTKEY_API_KEY> & <OPENAI_API_KEY> with actual values from the following snippet.
cURL
curl --location 'http://api.portkey.ai/v1/proxy/completions' \
--header 'x-portkey-api-key: <PORTKEY_API_KEY>' \
--header 'x-portkey-mode: proxy openai' \
--header 'Authorization: Bearer <OPENAI_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
    "n": 1,
    "model": "text-davinci-003",
    "prompt": "Top 20 tallest buildings in the world"
}'
Azure Open AI
For Azure OpenAI, change the basepath by prefixing the Portkey's base URL followed by the Azure deployment endpoint. 
For example, a typical azure endpoint looks like this:
https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=202305-15

After adding the prefix it should change to:
https://api.portkey.ai/v1/proxy/YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=2023-05-15

Add the  x-portkey-api-key & x-portkey-mode headers. Mode value for Azure OpenAI should proxy azure-openai
Replace <PORTKEY_API_KEY>,<AZURE_OPENAI_KEY>, <YOUR_RESOURCE_NAME>,  <YOUR_DEPLOYMENT_NAME>  with actual values from the following snippet.
cURL
curl --location 'https://api.portkey.ai/v1/proxy/<YOUR_RESOURCE_NAME>.openai.azure.com/openai/deployments/<YOUR_DEPLOYMENT_NAME>/completions?api-version=2023-05-15' \
--header 'api-key: <AZURE_OPENAI_KEY>' \
--header 'x-portkey-api-key: <PORTKEY_API_KEY>' \
--header 'x-portkey-mode: proxy azure-openai' \
--header 'Content-Type: application/json' \
--data '{        
    "prompt":"Once upon a time"
}'
Cohere
For Cohere, change the API basepath according to the Cohere endpoint you are calling, and add the x-portkey-api-key & x-portkey-mode headers. Mode value for Cohere should proxy cohere
Replace <PORTKEY_API_KEY> & <COHERE_API_KEY> with actual values from the following snippet.
cURL
```powershell
curl --location 'http://portkey.ai/v1/proxy/generate' \
--header 'x-portkey-api-key: <PORTKEY_API_KEY>' \
--header 'Authorization: Bearer <COHERE_API_KEY>' \
--header 'x-portkey-mode: proxy cohere' \
--header 'Content-Type: application/json' \
--header 'x-portkey-cache: true' \
--data '{
  "max_tokens": 10,
  "return_likelihoods": "NONE",
  "truncate": "END",
  "prompt": "Once upon a time in a magical land called"
}'
```
Anthropic
For Anthropic, change the API basepath and add the x-portkey-api-key & x-portkey-mode headers. Mode value for OpenAI should proxy anthropic. Anthropic only supports /complete end point as of now. 
Replace <PORTKEY_API_KEY> & <ANTHROPIC_API_KEY> with actual values from the following snippet.
cURL
curl --location 'https://api.portkey.ai/v1/proxy/complete' \
--header 'x-portkey-api-key: <POTKEY_API_KEY>' \
--header 'x-api-key: <ANTHROPIC_API_KEY>' \
--header 'x-portkey-mode: proxy anthropic' \
--header 'Content-Type: application/json' \
--header 'x-portkey-cache: true' \
--data '{
    "prompt": "\n\nHuman: Tell me a haiku about trees\n\nAssistant: ",
    "model": "claude-v1",
    "max_tokens_to_sample": 300,
    "stop_sequences": [
        "\n\nHuman:"
    ]
}'
Langchain
Portkey Headers
Last modified 4mo ago