Skip to content

Commit 7bcaf3e

Browse files
techpro-aimlapigitbook-bot
authored andcommitted
GITBOOK-944: docs: fix some slugs/urls, add redirects, change how to make a call section for llms
1 parent 4bba6b2 commit 7bcaf3e

60 files changed

Lines changed: 952 additions & 1002 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/SUMMARY.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@
121121
* [NVIDIA](api-references/text-models-llm/NVIDIA/README.md)
122122
* [llama-3.1-nemotron-70b](api-references/text-models-llm/NVIDIA/llama-3.1-nemotron-70b.md)
123123
* [nemotron-nano-9b-v2](api-references/text-models-llm/nvidia/nemotron-nano-9b-v2.md)
124-
* [nemotron-nano-12b-v2-vl](api-references/text-models-llm/nvidia/llama-3.1-nemotron-70b-1.md)
124+
* [nemotron-nano-12b-v2-vl](api-references/text-models-llm/nvidia/nemotron-nano-12b-v2-vl.md)
125125
* [OpenAI](api-references/text-models-llm/OpenAI/README.md)
126126
* [gpt-3.5-turbo](api-references/text-models-llm/OpenAI/gpt-3.5-turbo.md)
127127
* [gpt-4](api-references/text-models-llm/OpenAI/gpt-4.md)
@@ -231,7 +231,7 @@
231231
* [DALL·E 3](api-references/image-models/OpenAI/dall-e-3.md)
232232
* [gpt-image-1](api-references/image-models/openai/gpt-image-1.md)
233233
* [gpt-image-1-mini](api-references/image-models/openai/gpt-image-1-mini.md)
234-
* [gpt-image-1-5](api-references/image-models/openai/gpt-image-1-mini-1.md)
234+
* [gpt-image-1-5](api-references/image-models/openai/gpt-image-1-5.md)
235235
* [RecraftAI](api-references/image-models/RecraftAI/README.md)
236236
* [Recraft v3](api-references/image-models/RecraftAI/recraft-v3.md)
237237
* [Reve](api-references/image-models/reve/README.md)

docs/api-references/image-models/openai/gpt-image-1-mini-1.md renamed to docs/api-references/image-models/openai/gpt-image-1-5.md

File renamed without changes.

‎docs/api-references/model-database.md‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎docs/api-references/text-models-llm/DeepSeek/deepseek-chat.md‎

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -25,33 +25,31 @@ All three IDs listed above refer to the same model; we support them for backward
2525

2626
DeepSeek V3 (or deepseek-chat) is an advanced conversational AI designed to deliver highly engaging and context-aware dialogues. This model excels in understanding and generating human-like text, making it an ideal solution for creating responsive and intelligent chatbots.
2727

28-
## How to Make a Call
28+
{% hint style="success" %}
29+
[Create AI/ML API Key](https://aimlapi.com/app/keys)
30+
{% endhint %}
2931

3032
<details>
3133

32-
<summary>Step-by-Step Instructions</summary>
33-
34-
:digit\_one: **Setup You Can’t Skip**
35-
36-
:black\_small\_square: [**Create an Account**](https://aimlapi.com/app/sign-up): Visit the AI/ML API website and create an account (if you don’t have one yet).\
37-
:black\_small\_square: [**Generate an API Key**](https://aimlapi.com/app/keys): After logging in, navigate to your account dashboard and generate your API key. Ensure that key is enabled on UI.
38-
39-
:digit\_two: **Copy the code example**
40-
41-
At the bottom of this page, you'll find [a code example](deepseek-chat.md#code-example) that shows how to structure the request. Choose the code snippet in your preferred programming language and copy it into your development environment.
42-
43-
:digit\_three: **Modify the code example**
34+
<summary>How to make the first API call</summary>
4435

45-
:black\_small\_square: Replace `<YOUR_AIMLAPI_KEY>` with your actual AI/ML API key from your account.\
46-
:black\_small\_square: Insert your question or request into the `content` field—this is what the model will respond to.
36+
**1️⃣ Required setup (don’t skip this)**\
37+
▪ **Create an account:** Sign up on the AI/ML API website (if you don’t have one yet).\
38+
▪ **Generate an API key:** In your account dashboard, create an API key and make sure it’s **enabled** in the UI.
4739

48-
:digit\_four: <sup><sub><mark style="background-color:yellow;">**(Optional)**<mark style="background-color:yellow;"><sub></sup>**&#x20;Adjust other optional parameters if needed**
40+
**2️ Copy the code example**\
41+
At the bottom of this page, pick the snippet for your preferred programming language (Python / Node.js) and copy it into your project.
4942

50-
Only `model` and `messages` are required parameters for this model (and we’ve already filled them in for you in the example), but you can include optional parameters if needed to adjust the model’s behavior. Below, you can find the corresponding [API schema](deepseek-chat.md#api-schema), which lists all available parameters along with notes on how to use them.
43+
**3️ Update the snippet for your use case**\
44+
▪ **Insert your API key:** replace `<YOUR_AIMLAPI_KEY>` with your real AI/ML API key.\
45+
▪ **Select a model:** set the `model` field to the model you want to call.\
46+
▪ **Provide input:** fill in the request input field(s) shown in the example (for example, `messages` for chat/LLM models, or other inputs for image/video/audio models).
5147

52-
:digit\_five: **Run your modified code**
48+
**4️ (Optional) Tune the request**\
49+
Depending on the model type, you can add optional parameters to control the output (e.g., generation settings, quality, length, etc.). See the API schema below for the full list.
5350

54-
Run your modified code in your development environment. Response time depends on various factors, but for simple prompts it rarely exceeds a few seconds.
51+
**5️ Run your code**\
52+
Run the updated code in your development environment. Response time depends on the model and request size, but simple requests typically return quickly.
5553

5654
{% hint style="success" %}
5755
If you need a more detailed walkthrough for setting up your development environment and making a request step by step — feel free to use our [Quickstart guide](/broken/pages/ngeSCZKxiGVWqYZTHDjY).

‎docs/api-references/text-models-llm/DeepSeek/deepseek-r1.md‎

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,33 +23,31 @@ Both IDs listed above refer to the same model; we support them for backward comp
2323

2424
DeepSeek R1 is a cutting-edge reasoning model developed by DeepSeek AI, designed to excel in complex problem-solving, mathematical reasoning, and programming assistance.
2525

26-
## How to Make a Call
26+
{% hint style="success" %}
27+
[Create AI/ML API Key](https://aimlapi.com/app/keys)
28+
{% endhint %}
2729

2830
<details>
2931

30-
<summary>Step-by-Step Instructions</summary>
31-
32-
:digit\_one: **Setup You Can’t Skip**
33-
34-
:black\_small\_square: [**Create an Account**](https://aimlapi.com/app/sign-up): Visit the AI/ML API website and create an account (if you don’t have one yet).\
35-
:black\_small\_square: [**Generate an API Key**](https://aimlapi.com/app/keys): After logging in, navigate to your account dashboard and generate your API key. Ensure that key is enabled on UI.
36-
37-
:digit\_two: **Copy the code example**
38-
39-
At the bottom of this page, you'll find [a code example](deepseek-r1.md#code-example) that shows how to structure the request. Choose the code snippet in your preferred programming language and copy it into your development environment.
40-
41-
:digit\_three: **Modify the code example**
32+
<summary>How to make the first API call</summary>
4233

43-
:black\_small\_square: Replace `<YOUR_AIMLAPI_KEY>` with your actual AI/ML API key from your account.\
44-
:black\_small\_square: Insert your question or request into the `content` field—this is what the model will respond to.
34+
**1️⃣ Required setup (don’t skip this)**\
35+
▪ **Create an account:** Sign up on the AI/ML API website (if you don’t have one yet).\
36+
▪ **Generate an API key:** In your account dashboard, create an API key and make sure it’s **enabled** in the UI.
4537

46-
:digit\_four: <sup><sub><mark style="background-color:yellow;">**(Optional)**<mark style="background-color:yellow;"><sub></sup>**&#x20;Adjust other optional parameters if needed**
38+
**2️ Copy the code example**\
39+
At the bottom of this page, pick the snippet for your preferred programming language (Python / Node.js) and copy it into your project.
4740

48-
Only `model` and `messages` are required parameters for this model (and we’ve already filled them in for you in the example), but you can include optional parameters if needed to adjust the model’s behavior. Below, you can find the corresponding [API schema](deepseek-r1.md#api-schema), which lists all available parameters along with notes on how to use them.
41+
**3️ Update the snippet for your use case**\
42+
▪ **Insert your API key:** replace `<YOUR_AIMLAPI_KEY>` with your real AI/ML API key.\
43+
▪ **Select a model:** set the `model` field to the model you want to call.\
44+
▪ **Provide input:** fill in the request input field(s) shown in the example (for example, `messages` for chat/LLM models, or other inputs for image/video/audio models).
4945

50-
:digit\_five: **Run your modified code**
46+
**4️ (Optional) Tune the request**\
47+
Depending on the model type, you can add optional parameters to control the output (e.g., generation settings, quality, length, etc.). See the API schema below for the full list.
5148

52-
Run your modified code in your development environment. Response time depends on various factors, but for simple prompts it rarely exceeds a few seconds.
49+
**5️ Run your code**\
50+
Run the updated code in your development environment. Response time depends on the model and request size, but simple requests typically return quickly.
5351

5452
{% hint style="success" %}
5553
If you need a more detailed walkthrough for setting up your development environment and making a request step by step — feel free to use our [Quickstart guide](/broken/pages/ngeSCZKxiGVWqYZTHDjY).

‎docs/api-references/text-models-llm/Google/gemini-2.0-flash-exp.md‎

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,33 +19,31 @@ This documentation is valid for the following list of our models:
1919

2020
A cutting-edge multimodal AI model developed by Google DeepMind, designed to power agentic experiences. This model is capable of processing text and images.
2121

22-
## How to Make a Call
22+
{% hint style="success" %}
23+
[Create AI/ML API Key](https://aimlapi.com/app/keys)
24+
{% endhint %}
2325

2426
<details>
2527

26-
<summary>Step-by-Step Instructions</summary>
27-
28-
:digit\_one: **Setup You Can’t Skip**
29-
30-
:black\_small\_square: [**Create an Account**](https://aimlapi.com/app/sign-up): Visit the AI/ML API website and create an account (if you don’t have one yet).\
31-
:black\_small\_square: [**Generate an API Key**](https://aimlapi.com/app/keys): After logging in, navigate to your account dashboard and generate your API key. Ensure that key is enabled on UI.
32-
33-
:digit\_two: **Copy the code example**
34-
35-
At the bottom of this page, you'll find [a code example](gemini-2.0-flash-exp.md#code-example) that shows how to structure the request. Choose the code snippet in your preferred programming language and copy it into your development environment.
36-
37-
:digit\_three: **Modify the code example**
28+
<summary>How to make the first API call</summary>
3829

39-
:black\_small\_square: Replace `<YOUR_AIMLAPI_KEY>` with your actual AI/ML API key from your account.\
40-
:black\_small\_square: Insert your question or request into the `content` field—this is what the model will respond to.
30+
**1️⃣ Required setup (don’t skip this)**\
31+
▪ **Create an account:** Sign up on the AI/ML API website (if you don’t have one yet).\
32+
▪ **Generate an API key:** In your account dashboard, create an API key and make sure it’s **enabled** in the UI.
4133

42-
:digit\_four: <sup><sub><mark style="background-color:yellow;">**(Optional)**<mark style="background-color:yellow;"><sub></sup>**&#x20;Adjust other optional parameters if needed**
34+
**2️ Copy the code example**\
35+
At the bottom of this page, pick the snippet for your preferred programming language (Python / Node.js) and copy it into your project.
4336

44-
Only `model` and `messages` are required parameters for this model (and we’ve already filled them in for you in the example), but you can include optional parameters if needed to adjust the model’s behavior. Below, you can find the corresponding [API schema](gemini-2.0-flash-exp.md#api-schema), which lists all available parameters along with notes on how to use them.
37+
**3️ Update the snippet for your use case**\
38+
▪ **Insert your API key:** replace `<YOUR_AIMLAPI_KEY>` with your real AI/ML API key.\
39+
▪ **Select a model:** set the `model` field to the model you want to call.\
40+
▪ **Provide input:** fill in the request input field(s) shown in the example (for example, `messages` for chat/LLM models, or other inputs for image/video/audio models).
4541

46-
:digit\_five: **Run your modified code**
42+
**4️ (Optional) Tune the request**\
43+
Depending on the model type, you can add optional parameters to control the output (e.g., generation settings, quality, length, etc.). See the API schema below for the full list.
4744

48-
Run your modified code in your development environment. Response time depends on various factors, but for simple prompts it rarely exceeds a few seconds.
45+
**5️ Run your code**\
46+
Run the updated code in your development environment. Response time depends on the model and request size, but simple requests typically return quickly.
4947

5048
{% hint style="success" %}
5149
If you need a more detailed walkthrough for setting up your development environment and making a request step by step — feel free to use our [Quickstart guide](/broken/pages/ngeSCZKxiGVWqYZTHDjY).

‎docs/api-references/text-models-llm/Meta/Llama-3.2-3B-Instruct-Turbo.md‎

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,33 +18,31 @@ This documentation is valid for the following list of our models:
1818

1919
A large language model (LLM) optimized for instruction-following tasks, striking a balance between computational efficiency and high-quality performance. It excels in multilingual tasks, offering a lightweight solution without compromising on quality.
2020

21-
## How to Make a Call
21+
{% hint style="success" %}
22+
[Create AI/ML API Key](https://aimlapi.com/app/keys)
23+
{% endhint %}
2224

2325
<details>
2426

25-
<summary>Step-by-Step Instructions</summary>
26-
27-
:digit\_one: **Setup You Can’t Skip**
28-
29-
:black\_small\_square: [**Create an Account**](https://aimlapi.com/app/sign-up): Visit the AI/ML API website and create an account (if you don’t have one yet).\
30-
:black\_small\_square: [**Generate an API Key**](https://aimlapi.com/app/keys): After logging in, navigate to your account dashboard and generate your API key. Ensure that key is enabled on UI.
31-
32-
:digit\_two: **Copy the code example**
33-
34-
At the bottom of this page, you'll find [a code example](Llama-3.2-3B-Instruct-Turbo.md#code-example) that shows how to structure the request. Choose the code snippet in your preferred programming language and copy it into your development environment.
35-
36-
:digit\_three: **Modify the code example**
27+
<summary>How to make the first API call</summary>
3728

38-
:black\_small\_square: Replace `<YOUR_AIMLAPI_KEY>` with your actual AI/ML API key from your account.\
39-
:black\_small\_square: Insert your question or request into the `content` field—this is what the model will respond to.
29+
**1️⃣ Required setup (don’t skip this)**\
30+
▪ **Create an account:** Sign up on the AI/ML API website (if you don’t have one yet).\
31+
▪ **Generate an API key:** In your account dashboard, create an API key and make sure it’s **enabled** in the UI.
4032

41-
:digit\_four: <sup><sub><mark style="background-color:yellow;">**(Optional)**<mark style="background-color:yellow;"><sub></sup>**&#x20;Adjust other optional parameters if needed**
33+
**2️ Copy the code example**\
34+
At the bottom of this page, pick the snippet for your preferred programming language (Python / Node.js) and copy it into your project.
4235

43-
Only `model` and `messages` are required parameters for this model (and we’ve already filled them in for you in the example), but you can include optional parameters if needed to adjust the model’s behavior. Below, you can find the corresponding [API schema](Llama-3.2-3B-Instruct-Turbo.md#api-schema), which lists all available parameters along with notes on how to use them.
36+
**3️ Update the snippet for your use case**\
37+
▪ **Insert your API key:** replace `<YOUR_AIMLAPI_KEY>` with your real AI/ML API key.\
38+
▪ **Select a model:** set the `model` field to the model you want to call.\
39+
▪ **Provide input:** fill in the request input field(s) shown in the example (for example, `messages` for chat/LLM models, or other inputs for image/video/audio models).
4440

45-
:digit\_five: **Run your modified code**
41+
**4️ (Optional) Tune the request**\
42+
Depending on the model type, you can add optional parameters to control the output (e.g., generation settings, quality, length, etc.). See the API schema below for the full list.
4643

47-
Run your modified code in your development environment. Response time depends on various factors, but for simple prompts it rarely exceeds a few seconds.
44+
**5️ Run your code**\
45+
Run the updated code in your development environment. Response time depends on the model and request size, but simple requests typically return quickly.
4846

4947
{% hint style="success" %}
5048
If you need a more detailed walkthrough for setting up your development environment and making a request step by step — feel free to use our [Quickstart guide](/broken/pages/ngeSCZKxiGVWqYZTHDjY).

‎docs/api-references/text-models-llm/Meta/Llama-3.3-70B-Instruct-Turbo.md‎

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -18,33 +18,31 @@ This documentation is valid for the following list of our models:
1818

1919
An optimized language model designed for efficient text generation with advanced features and multilingual support. Specifically tuned for instruction-following tasks, making it suitable for applications requiring conversational capabilities and task-oriented responses.
2020

21-
## How to Make a Call
21+
{% hint style="success" %}
22+
[Create AI/ML API Key](https://aimlapi.com/app/keys)
23+
{% endhint %}
2224

2325
<details>
2426

25-
<summary>Step-by-Step Instructions</summary>
26-
27-
:digit\_one: **Setup You Can’t Skip**
28-
29-
:black\_small\_square: [**Create an Account**](https://aimlapi.com/app/sign-up): Visit the AI/ML API website and create an account (if you don’t have one yet).\
30-
:black\_small\_square: [**Generate an API Key**](https://aimlapi.com/app/keys): After logging in, navigate to your account dashboard and generate your API key. Ensure that key is enabled on UI.
31-
32-
:digit\_two: **Copy the code example**
33-
34-
At the bottom of this page, you'll find [a code example](Llama-3.3-70B-Instruct-Turbo.md#code-example) that shows how to structure the request. Choose the code snippet in your preferred programming language and copy it into your development environment.
35-
36-
:digit\_three: **Modify the code example**
27+
<summary>How to make the first API call</summary>
3728

38-
:black\_small\_square: Replace `<YOUR_AIMLAPI_KEY>` with your actual AI/ML API key from your account.\
39-
:black\_small\_square: Insert your question or request into the `content` field—this is what the model will respond to.
29+
**1️⃣ Required setup (don’t skip this)**\
30+
▪ **Create an account:** Sign up on the AI/ML API website (if you don’t have one yet).\
31+
▪ **Generate an API key:** In your account dashboard, create an API key and make sure it’s **enabled** in the UI.
4032

41-
:digit\_four: <sup><sub><mark style="background-color:yellow;">**(Optional)**<mark style="background-color:yellow;"><sub></sup>**&#x20;Adjust other optional parameters if needed**
33+
**2️ Copy the code example**\
34+
At the bottom of this page, pick the snippet for your preferred programming language (Python / Node.js) and copy it into your project.
4235

43-
Only `model` and `messages` are required parameters for this model (and we’ve already filled them in for you in the example), but you can include optional parameters if needed to adjust the model’s behavior. Below, you can find the corresponding [API schema](Llama-3.3-70B-Instruct-Turbo.md#api-schema), which lists all available parameters along with notes on how to use them.
36+
**3️ Update the snippet for your use case**\
37+
▪ **Insert your API key:** replace `<YOUR_AIMLAPI_KEY>` with your real AI/ML API key.\
38+
▪ **Select a model:** set the `model` field to the model you want to call.\
39+
▪ **Provide input:** fill in the request input field(s) shown in the example (for example, `messages` for chat/LLM models, or other inputs for image/video/audio models).
4440

45-
:digit\_five: **Run your modified code**
41+
**4️ (Optional) Tune the request**\
42+
Depending on the model type, you can add optional parameters to control the output (e.g., generation settings, quality, length, etc.). See the API schema below for the full list.
4643

47-
Run your modified code in your development environment. Response time depends on various factors, but for simple prompts it rarely exceeds a few seconds.
44+
**5️ Run your code**\
45+
Run the updated code in your development environment. Response time depends on the model and request size, but simple requests typically return quickly.
4846

4947
{% hint style="success" %}
5048
If you need a more detailed walkthrough for setting up your development environment and making a request step by step — feel free to use our [Quickstart guide](/broken/pages/ngeSCZKxiGVWqYZTHDjY).

0 commit comments

Comments
 (0)