Skip to content

update documentation as deprecated for createmodelapikey endpoint #1182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lkapadiya-DO wants to merge 8 commits into
base: main
Choose a base branch
from
+20 −21
Open

update documentation as deprecated for createmodelapikey endpoint #1182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8a2cf35
mark CreateModelAPIKey endpoint as deprecated
lkapadiya-DO May 29, 2026
32aecce
updated the error message
lkapadiya-DO May 29, 2026
57aa0bf
removed the link
lkapadiya-DO May 29, 2026
556c482
added specific message
lkapadiya-DO May 29, 2026
75fdeaa
Merge branch 'main' into lkapadiya/update-documentation-as-deprecated…
DO-rrao Jun 8, 2026
8de05f4
Add additional fields to Update Custom Model Metadata Input (#1183)
venkatranabothu Jun 8, 2026
0524d26
removed orphaned file
lkapadiya-DO Jun 9, 2026
75fd397
Merge branch 'main' into lkapadiya/update-documentation-as-deprecated…
lkapadiya-DO Jun 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions specification/resources/gen-ai/examples/curl/genai_create_model_api_key.yml
View file
Open in desktop

This file was deleted.

32 changes: 20 additions & 12 deletions specification/resources/gen-ai/genai_create_model_api_key.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,39 @@
description: To create a model API key, send a POST request to `/v2/gen-ai/models/api_keys`.
deprecated: true

summary: Create a Model API Key
description: |
**Note: This endpoint is deprecated and has been retired. All requests return a `410 gone` response.**

Creating model API keys through this endpoint is no longer supported. To create a model access key, visit the manage page in the control panel.

Previously, you could create a model API key by sending a POST request to `/v2/gen-ai/models/api_keys`.
operationId: genai_create_model_api_key
requestBody:
content:

@DO-rrao DO-rrao Jun 1, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please create a ticket for future removal of this documentation from openapi (and other repos if needed)

application/json:
schema:
$ref: ./definitions.yml#/apiCreateModelAPIKeyInputPublic
responses:
"200":
content:
application/json:
schema:
$ref: ./definitions.yml#/apiCreateModelAPIKeyOutput
description: A successful response.
"410":
description: The endpoint has been retired.
headers:
ratelimit-limit:
$ref: ../../shared/headers.yml#/ratelimit-limit
ratelimit-remaining:
$ref: ../../shared/headers.yml#/ratelimit-remaining
ratelimit-reset:
$ref: ../../shared/headers.yml#/ratelimit-reset
content:
application/json:
schema:
$ref: ../../shared/models/error.yml
example:
id: gone
message: >-
resource retired: Creating model API keys through this endpoint is retired.
Go to manage page in the control panel to create a model access key.
"401":
$ref: ../../shared/responses/unauthorized.yml
"404":
$ref: ../../shared/responses/not_found.yml
"429":
$ref: ../../shared/responses/too_many_requests.yml
"500":
Expand All @@ -32,8 +43,5 @@ responses:
security:
- bearer_auth:
- genai:create
summary: Create a Model API Key
tags:
- GradientAI Platform
x-codeSamples:
- $ref: examples/curl/genai_create_model_api_key.yml
Loading