Skip to content

Commit ec4282e

Browse files
aimlapihellogitbook-bot
authored andcommitted
GITBOOK-932: API Keys update
1 parent 663f04f commit ec4282e

1 file changed

Lines changed: 5 additions & 9 deletions

File tree

‎docs/api-references/service-endpoints/api-key-management.md‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,24 @@
11
# API Key Management
22

3-
This section describes the API methods for managing your API keys. 
4-
5-
<table data-header-hidden data-full-width="true"><thead><tr><th width="159.016845703125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Create an API key</td><td valign="top"><img src="../../.gitbook/assets/post.png" alt="" data-size="line"> <code>https://api.aimlapi.com/v1/keys</code></td></tr><tr><td valign="top">List all API keys</td><td valign="top"><img src="../../.gitbook/assets/get.png" alt="" data-size="line"> <code>https://api.aimlapi.com/v1/keys</code></td></tr><tr><td valign="top">Get the API key</td><td valign="top"><img src="../../.gitbook/assets/get.png" alt="" data-size="line"> <code>https://api.aimlapi.com/v1/key</code></td></tr><tr><td valign="top">Update an API key</td><td valign="top"><img src="../../.gitbook/assets/put.png" alt="" data-size="line"> <code>https://api.aimlapi.com/v1/keys/{prefix}</code></td></tr><tr><td valign="top">Delete an API key</td><td valign="top"><img src="../../.gitbook/assets/delete.png" alt="" data-size="line"> <code>https://api.aimlapi.com/v1/keys/{prefix}</code></td></tr></tbody></table>
3+
<table data-header-hidden data-full-width="true"><thead><tr><th width="185.762939453125" valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top"><a href="api-key-management.md#create-an-api-key">Create a new API key</a></td><td valign="top"><mark style="color:$warning;"><strong><code>POST</code></strong></mark> <code>https://api.aimlapi.com/v1/keys</code></td></tr><tr><td valign="top"><a href="api-key-management.md#list-api-keys">List API keys</a></td><td valign="top"><mark style="color:$success;"><strong><code>GET</code></strong></mark> <code>https://api.aimlapi.com/v1/keys</code></td></tr><tr><td valign="top"><a href="api-key-management.md#get-the-api-key">Get the API key</a></td><td valign="top"><mark style="color:$success;"><strong><code>GET</code></strong></mark> <code>https://api.aimlapi.com/v1/key</code></td></tr><tr><td valign="top"><a href="api-key-management.md#update-an-api-key">Update an API key</a></td><td valign="top"><mark style="color:blue;"><strong><code>PUT</code></strong></mark> <code>https://api.aimlapi.com/v1/keys/{prefix}</code></td></tr><tr><td valign="top"><a href="api-key-management.md#delete-an-api-key">Delete an API key</a></td><td valign="top"><mark style="color:$danger;"><strong><code>DELETE</code></strong></mark> <code>https://api.aimlapi.com/v1/keys/{prefix}</code></td></tr></tbody></table>
64

75
{% hint style="warning" %}
86
Before you start you should create [a managment key](../../faq/how-can-i-work-with-my-api-keys.md#management-keys).
97
{% endhint %}
108

11-
## API Schemas
12-
13-
### Create an API key
9+
### Create a new API key
1410

15-
Copy the created key and store it in a secure location. If the key is lost, create a new one.
11+
Copy the created key and store it in a secure location. If the key is lost, create a new one.&#x20;
1612

1713
{% openapi-operation spec="keys-post" path="/keys" method="post" %}
1814
[OpenAPI keys-post](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/service-endpoints/keys-post.json)
1915
{% endopenapi-operation %}
2016

2117
***
2218

23-
### List all API keys
19+
### List API keys
2420

25-
Retrieve a list of your API keys along with their parameters.
21+
Returns all API keys for your account, including each key’s settings and metadata.
2622

2723
{% openapi-operation spec="keys-get" path="/keys" method="get" %}
2824
[OpenAPI keys-get](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/service-endpoints/keys-get.json)

0 commit comments

Comments
 (0)