Create API Key

POST

accounts

{account_id}

users

{user_id}

apiKeys

Create API Key

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiKey": {
    "displayName": "<string>",
    "expireTime": "2023-11-07T05:31:56Z",
    "annotations": {},
    "isFirepass": true
  }
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys"

payload = { "apiKey": {
        "displayName": "<string>",
        "expireTime": "2023-11-07T05:31:56Z",
        "annotations": {},
        "isFirepass": True
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    apiKey: {
      displayName: '<string>',
      expireTime: '2023-11-07T05:31:56Z',
      annotations: {},
      isFirepass: true
    }
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'apiKey' => [
        'displayName' => '<string>',
        'expireTime' => '2023-11-07T05:31:56Z',
        'annotations' => [
                
        ],
        'isFirepass' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys"

	payload := strings.NewReader("{\n  \"apiKey\": {\n    \"displayName\": \"<string>\",\n    \"expireTime\": \"2023-11-07T05:31:56Z\",\n    \"annotations\": {},\n    \"isFirepass\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"apiKey\": {\n    \"displayName\": \"<string>\",\n    \"expireTime\": \"2023-11-07T05:31:56Z\",\n    \"annotations\": {},\n    \"isFirepass\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"apiKey\": {\n    \"displayName\": \"<string>\",\n    \"expireTime\": \"2023-11-07T05:31:56Z\",\n    \"annotations\": {},\n    \"isFirepass\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "keyId": "<string>",
  "displayName": "<string>",
  "key": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "secure": true,
  "email": "<string>",
  "prefix": "<string>",
  "expireTime": "2023-11-07T05:31:56Z",
  "annotations": {},
  "lastUsed": "2023-11-07T05:31:56Z",
  "isFirepass": true
}

Authorizations

Authorization

string

header

required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id

string

required

The Account Id

user_id

string

required

The User Id

Body

application/json

apiKey

object

required

The API key to be created.

Show child attributes

Response

200 - application/json

A successful response.

keyId

string

read-only

Unique identifier (Key ID) for the API key, used primarily for deletion.

displayName

string

Display name for the API key, defaults to "default" if not specified.

key

string

read-only

The actual API key value, only available upon creation and not stored thereafter.

createTime

string<date-time>

read-only

Timestamp indicating when the API key was created.

secure

boolean

read-only

Indicates whether the plaintext value of the API key is unknown to Fireworks. If true, Fireworks does not know this API key's plaintext value. If false, Fireworks does know the plaintext value.

string

read-only

Email of the user who owns this API key.

prefix

string

read-only

expireTime

string<date-time>

Timestamp indicating when the API key will expire. API keys have a maximum expiration of 1 year (365 days); a value later than that is rejected. If not set on create, the key expires 1 year after creation.

annotations

object

Optional key-value annotations for this API key.

Show child attributes

lastUsed

string<date-time>

read-only

Timestamp indicating when the API key was last used. Not set if the key has never been used.

isFirepass

boolean

True when this key is a FirePass inference key.

Create API Key

curl --request POST \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiKey": {
    "displayName": "<string>",
    "expireTime": "2023-11-07T05:31:56Z",
    "annotations": {},
    "isFirepass": true
  }
}
'

import requests

url = "https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys"

payload = { "apiKey": {
        "displayName": "<string>",
        "expireTime": "2023-11-07T05:31:56Z",
        "annotations": {},
        "isFirepass": True
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    apiKey: {
      displayName: '<string>',
      expireTime: '2023-11-07T05:31:56Z',
      annotations: {},
      isFirepass: true
    }
  })
};

fetch('https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'apiKey' => [
        'displayName' => '<string>',
        'expireTime' => '2023-11-07T05:31:56Z',
        'annotations' => [
                
        ],
        'isFirepass' => true
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys"

	payload := strings.NewReader("{\n  \"apiKey\": {\n    \"displayName\": \"<string>\",\n    \"expireTime\": \"2023-11-07T05:31:56Z\",\n    \"annotations\": {},\n    \"isFirepass\": true\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"apiKey\": {\n    \"displayName\": \"<string>\",\n    \"expireTime\": \"2023-11-07T05:31:56Z\",\n    \"annotations\": {},\n    \"isFirepass\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fireworks.ai/v1/accounts/{account_id}/users/{user_id}/apiKeys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"apiKey\": {\n    \"displayName\": \"<string>\",\n    \"expireTime\": \"2023-11-07T05:31:56Z\",\n    \"annotations\": {},\n    \"isFirepass\": true\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "keyId": "<string>",
  "displayName": "<string>",
  "key": "<string>",
  "createTime": "2023-11-07T05:31:56Z",
  "secure": true,
  "email": "<string>",
  "prefix": "<string>",
  "expireTime": "2023-11-07T05:31:56Z",
  "annotations": {},
  "lastUsed": "2023-11-07T05:31:56Z",
  "isFirepass": true
}

API Reference

Inference

Deployments

Training

Training SDK

Admin

Authorizations

Path Parameters

Body

Response