# Create an API key Source: https://jointextkit.com/docs/api/api-keys/create Index: https://jointextkit.com/llms.txt `POST /v1/api_keys` A key for an app you build, to keep as a secret (for example TEXTKIT_API_KEY). Same mode as the calling key. A key with limited scopes can only create keys with scopes inside its own. The secret is returned once. The owner and admins are emailed. 20 per hour. Send your API key as a bearer token: `Authorization: Bearer ssms_sk_...`. Test keys run this endpoint against the [sandbox](/docs/sandbox); see [Authentication](/docs/authentication) for key modes and scopes. ## Request body JSON (`Content-Type: application/json`). | Field | Type | Required | Description | | --- | --- | --- | --- | | `name` | string | Yes | What the key is for, e.g. "Booking app" At most 60 characters. | | `scopes` | array of string | No | Limit the key to these scopes (see /docs/authentication). Omit for full access (full-access callers only). | ## Responses | Status | Meaning | Body | | --- | --- | --- | | 201 | The key, with its secret (shown once) | `ApiKey` | | 400 | Invalid request | `Error` | | 401 | Missing, malformed, or revoked API key | `Error` | | 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | `Error` | | 429 | Rate limit or quota exceeded | `Error` | ### 201: `ApiKey` fields | Field | Type | Description | | --- | --- | --- | | `id` | string | | | `object` | `api_key` | | | `name` | string | | | `mode` | `test`, `live` | | | `prefix` | string | The start of the secret, for recognizing it | | `scopes` | array of string | Empty = full access | | `status` | `active`, `paused`, `revoked` | | | `created_at` | string (date-time) | | | `last_used_at` | string (date-time) | Nullable. | ## Errors | Status | When | | --- | --- | | 400 | Invalid request | | 401 | Missing, malformed, or revoked API key | | 402 | Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged | | 429 | Rate limit or quota exceeded | Every error has the same JSON shape, and `request_id` matches the `X-Request-Id` response header. [Errors](/docs/errors) lists every code and what to do about it. ```json { "error": { "code": "invalid_request", "message": "What went wrong, in plain words.", "param": "the_field", "request_id": "req_a1B2c3D4e5F6g7H8" } } ``` ## Examples ### Node.js The Node.js SDK does not wrap this endpoint yet; call it over HTTP. ```javascript const res = await fetch('https://api.jointextkit.com/v1/api_keys', { method: 'POST', headers: { Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "name": "Example" }), }); if (!res.ok) throw new Error((await res.json()).error.message); const data = await res.json(); ``` ### PHP ```php 'POST', CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('TEXTKIT_API_KEY'), 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => json_encode([ 'name' => 'Example', ]), ]); $data = json_decode(curl_exec($ch), true); ``` ### Python The Python SDK does not wrap this endpoint yet; call it over HTTP. ```python import json, os, urllib.request req = urllib.request.Request( "https://api.jointextkit.com/v1/api_keys", method="POST", headers={ "Authorization": f"Bearer {os.environ['TEXTKIT_API_KEY']}", "Content-Type": "application/json", }, data=json.dumps({ "name": "Example" }).encode(), ) with urllib.request.urlopen(req) as res: data = json.load(res) ``` ### Ruby ```ruby require "net/http" require "json" uri = URI("https://api.jointextkit.com/v1/api_keys") req = Net::HTTP::Post.new(uri) req["Authorization"] = "Bearer #{ENV["TEXTKIT_API_KEY"]}" req["Content-Type"] = "application/json" req.body = { "name": "Example" }.to_json res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) } data = JSON.parse(res.body) ``` ### Go ```go package main import ( "fmt" "io" "net/http" "os" "strings" ) func main() { body := strings.NewReader(`{ "name": "Example" }`) req, _ := http.NewRequest("POST", "https://api.jointextkit.com/v1/api_keys", body) req.Header.Set("Authorization", "Bearer "+os.Getenv("TEXTKIT_API_KEY")) req.Header.Set("Content-Type", "application/json") res, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer res.Body.Close() data, _ := io.ReadAll(res.Body) fmt.Println(res.Status, string(data)) } ``` ### Rust ```rust // cargo add reqwest --features blocking,json // cargo add serde_json use serde_json::json; fn main() -> Result<(), Box> { let key = std::env::var("TEXTKIT_API_KEY")?; let res = reqwest::blocking::Client::new() .post("https://api.jointextkit.com/v1/api_keys") .bearer_auth(key) .json(&json!({ "name": "Example" })) .send()? .error_for_status()?; let data: serde_json::Value = res.json()?; println!("{data}"); Ok(()) } ``` ### Java ```java import java.net.URI; import java.net.http.*; public class Main { public static void main(String[] args) throws Exception { var request = HttpRequest.newBuilder(URI.create("https://api.jointextkit.com/v1/api_keys")) .header("Authorization", "Bearer " + System.getenv("TEXTKIT_API_KEY")) .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString(""" { "name": "Example" } """)) .build(); var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.statusCode() + " " + response.body()); } } ``` ### .NET ```csharp using System.Net.Http.Headers; using System.Text; var http = new HttpClient(); http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue( "Bearer", Environment.GetEnvironmentVariable("TEXTKIT_API_KEY")); var body = new StringContent(""" { "name": "Example" } """, Encoding.UTF8, "application/json"); var res = await http.PostAsync("https://api.jointextkit.com/v1/api_keys", body); res.EnsureSuccessStatusCode(); var data = await res.Content.ReadAsStringAsync(); ``` ### cURL ```bash curl -X POST "https://api.jointextkit.com/v1/api_keys" \ -H "Authorization: Bearer $TEXTKIT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Example" }' ``` ## Related - [All api keys endpoints](/docs/api#api-keys) - [API reference](/docs/api)