> For the complete documentation index, see [llms.txt](https://docs.flashback.tech/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flashback.tech/support-reference/platform-api-reference/ai-apis/ai-llms/get_ai_llm.md).

# get\_\_ai\_llm

⚠️ TEST ENVIRONMENT ONLY

{% hint style="info" %}
This API endpoint is currently available only in the TEST environment. It is not yet available in production.
{% endhint %}

`GET /ai/llm`

*List AI LLM Configurations*

Retrieve a list of all AI/LLM provider configurations accessible to you. This endpoint returns configurations based on your workspace access permissions.

**Query Filtering:**

* Optionally filter by `workspaceId` to get configurations for a specific workspace
* Without filters, returns all configurations across your accessible workspaces

**Important Notes:**

* API secrets are never returned in responses (only masked/null values)
* Results include associated repository information if configurations are linked to repos
* Only returns configurations from workspaces you have access to

#### TypeScript Client Library

```typescript
public getAiLlms = async (workspaceId?: string): Promise<GetAiLlmsResponse> => {
  const queryParams = new URLSearchParams();
  if (workspaceId) {
    queryParams.append('workspaceId', workspaceId);
  }
  return this.makeRequest<GetAiLlmsResponse>(
    `ai/llm${queryParams.toString() ? `?${queryParams.toString()}` : ''}`,
    'GET',
    null
  );
};
```

#### Code Samples

{% tabs %}
{% tab title="Shell" %}

```shell
# You can also use wget
curl -X GET https://backend.flashback.tech/ai/llm?workspaceId=workspace-123 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'
```

{% endtab %}

{% tab title="HTTP" %}

```http
GET https://backend.flashback.tech/ai/llm?workspaceId=workspace-123 HTTP/1.1
Host: backend.flashback.tech
Accept: application/json
```

{% endtab %}

{% tab title="JavaScript" %}

```javascript
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://backend.flashback.tech/ai/llm?workspaceId=workspace-123',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
```

{% endtab %}

{% tab title="Ruby" %}

```ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://backend.flashback.tech/ai/llm',
  params: {
  'workspaceId' => 'string'
}, headers: headers

p JSON.parse(result)
```

{% endtab %}

{% tab title="Python" %}

```python
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://backend.flashback.tech/ai/llm', params={
  'workspaceId': 'workspace-123'
}, headers = headers)

print(r.json())
```

{% endtab %}

{% tab title="PHP" %}

```php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

try {
    $response = $client->request('GET','https://backend.flashback.tech/ai/llm', array(
        'headers' => $headers,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
```

{% endtab %}

{% tab title="Java" %}

```java
URL obj = new URL("https://backend.flashback.tech/ai/llm?workspaceId=workspace-123");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
```

{% endtab %}

{% tab title="Go" %}

```go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://backend.flashback.tech/ai/llm", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}
```

{% endtab %}
{% endtabs %}

#### Parameters <a href="#get__ai_llm-parameters" id="get__ai_llm-parameters"></a>

| Name        | In    | Type   | Required | Description                           |
| ----------- | ----- | ------ | -------- | ------------------------------------- |
| workspaceId | query | string | false    | Filter configurations by workspace ID |

> Example responses

> 200 Response

```json
{
  "success": true,
  "aiLlms": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "orgId": "org-123",
      "workspaceId": "workspace-123",
      "userId": "user-456",
      "name": "My OpenAI Config",
      "aiType": "OPENAI",
      "endpoint": "https://api.openai.com/v1",
      "key": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "repos": [
        {
          "id": "repo-789",
          "name": "my-ai-repo",
          "createdAt": "2024-01-16T08:00:00.000Z"
        }
      ]
    }
  ]
}
```

#### Responses <a href="#get__ai_llm-responses" id="get__ai_llm-responses"></a>

| Status | Meaning                                                                    | Description                           | Schema |
| ------ | -------------------------------------------------------------------------- | ------------------------------------- | ------ |
| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)                    | Successfully retrieved configurations | Inline |
| 403    | [Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)             | Insufficient permissions              | Inline |
| 500    | [Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1) | Failed to retrieve configurations     | Inline |

#### Response Schema <a href="#get__ai_llm-responseschema" id="get__ai_llm-responseschema"></a>

Status Code **200**

| Name           | Type      | Required | Restrictions | Description                             |
| -------------- | --------- | -------- | ------------ | --------------------------------------- |
| » success      | boolean   | false    | none         | Operation success status                |
| » aiLlms       | \[object] | false    | none         | Array of AI LLM configurations          |
| »» id          | string    | false    | none         | Unique identifier for the configuration |
| »» orgId       | string    | false    | none         | Organization ID                         |
| »» workspaceId | string    | false    | none         | Workspace ID                            |
| »» userId      | string    | false    | none         | User ID who created the configuration   |
| »» name        | string    | false    | none         | Configuration name                      |
| »» aiType      | string    | false    | none         | AI provider type (OPENAI, GOOGLE, etc.) |
| »» endpoint    | string    | false    | none         | API endpoint URL                        |
| »» key         | string    | false    | none         | Access key (always null for security)   |
| »» createdAt   | string    | false    | none         | ISO 8601 timestamp                      |
| »» repos       | \[object] | false    | none         | Associated repositories (optional)      |
| »»» id         | string    | false    | none         | Repository ID                           |
| »»» name       | string    | false    | none         | Repository name                         |
| »»» createdAt  | string    | false    | none         | Repository creation timestamp           |

Status Code **403**

| Name      | Type    | Required | Restrictions | Description |
| --------- | ------- | -------- | ------------ | ----------- |
| » success | boolean | false    | none         | none        |
| » message | string  | false    | none         | none        |

Status Code **500**

| Name      | Type    | Required | Restrictions | Description |
| --------- | ------- | -------- | ------------ | ----------- |
| » success | boolean | false    | none         | none        |
| » message | string  | false    | none         | none        |

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flashback.tech/support-reference/platform-api-reference/ai-apis/ai-llms/get_ai_llm.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
