Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 6 additions & 6 deletions src/pages/docs/admin-settings/api-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@ description: "Create, copy, and rotate FI_API_KEY and FI_SECRET_KEY credentials

API keys authenticate your application with Future AGI. Each key pair consists of an API Key (`FI_API_KEY`) and a Secret Key (`FI_SECRET_KEY`). You need these to use the Python SDK, TypeScript SDK, or REST API.

Access: **Owner** only.
Access: active organization members (**Owner**, **Admin**, **Member**, and **Viewer**) can create their own personal keys. Sign in interactively with a password or OAuth; API-key authentication and SAML-scoped sessions cannot issue personal keys. Managing other members' keys is restricted to **Owners** and **Admins**.

## How to

<Steps>
<Step title="Open Settings">
Navigate to **Settings > API Keys** at [https://app.futureagi.com/dashboard/keys](https://app.futureagi.com/dashboard/keys).
<Step title="Open Keys">
Open **Keys** under **Build** in the main sidebar, or go directly to [https://app.futureagi.com/dashboard/keys](https://app.futureagi.com/dashboard/keys).
</Step>
<Step title="Create a new key">
Click **Add API Key**. Enter a name for the key.
</Step>
<Step title="Copy your keys">
Copy both the API Key and Secret Key. The Secret Key is only shown once at creation time.
In **Save your personal key**, copy and securely save both the API Key and Secret Key before closing. Both values are shown only once, in this creation result; you cannot recover them from the key table later.
</Step>
<Step title="Use in your application">
Set them as environment variables.
Expand All @@ -41,8 +41,8 @@ Access: **Owner** only.

| Action | How |
|--------|-----|
| View keys | API Key is visible in the table. Secret Key is masked. |
| Copy a key | Click the copy icon next to the key. |
| View keys | Both API Key and Secret Key are masked in existing rows. The table cannot reveal either value. |
| Copy a key pair | Copy both values from the one-time creation result, before closing it. Existing rows do not offer copying of usable credentials. |
| Delete a key | Click the delete icon. This is permanent and cannot be undone. |
| Rotate keys | Delete the old key and create a new one. Update your application with the new credentials. |

Expand Down
7 changes: 5 additions & 2 deletions src/pages/docs/admin-settings/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Manage your Future AGI account: profile, organization, team member

## About

The Settings page is where you manage everything about your Future AGI account: your profile and security, organization configuration, team members, workspaces, API keys, AI provider connections, external integrations, and usage tracking.
The Settings page is where you manage your Future AGI account: your profile and security, organization configuration, team members, workspaces, AI provider connections, external integrations, and usage tracking. Personal API keys are under **Keys** in the main sidebar's **Build** section.

Access to different settings depends on your role. See [Roles & Permissions](/docs/roles-and-permissions) for details.

Expand Down Expand Up @@ -44,9 +44,12 @@ Access to different settings depends on your role. See [Roles & Permissions](/do

## Access by Role

Personal key creation requires active organization membership and an interactive password or OAuth sign-in, not API-key authentication or a SAML-scoped session. See [API Keys](/docs/admin-settings/api-keys).

| Section | Owner | Admin | Member | Viewer |
|---|---|---|---|---|
| API Keys | Yes | No | No | No |
| Create own personal API keys | Yes | Yes | Yes | Yes |
| Manage other members' API keys | Yes | Yes | No | No |
| Profile & Security | Yes | Yes | Yes | Yes |
| Organization Settings | Yes | Yes | No | No |
| User Management | Yes | Yes | No | No |
Expand Down
8 changes: 4 additions & 4 deletions src/pages/docs/agent-playground/guides/create-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,23 @@ title: "Create an agent"
description: "Create a new agent from scratch or a template"
---

Every agent in Agent Playground starts in the same place: a list you open from the sidebar, and a button that drops you onto a blank canvas. This guide gets a new agent onto that canvas and back out again if you ever need to delete it, nothing more.
Every agent in Agent Playground starts in the same place: **Agents** in the sidebar, then the creation menu's **Playground** option. This guide gets a new agent onto that canvas and back out again if you ever need to delete it, nothing more.

<Note>
The example built up across this section is an agent called **Invoice Triage**. Create yours under that name so later guides line up with what's on your screen.
</Note>

## Open the list and create an agent

Click **Agents** in the sidebar to see every agent in the workspace. Clicking anywhere on a row opens that agent, so there's no separate open button to look for. Once there are more agents than fit on one page, use the Search box above the table to find one by name, and the pagination controls beneath it to page through the rest. If the workspace has no agents yet, the list is replaced by an empty state instead: a **Create your first agent** heading, the line "Break down complex tasks into sequential steps that build upon each other." underneath, and a **Start creating** button in place of **Create Agent**. It opens the same empty canvas.
Click **Agents** in the sidebar. An initial visit opens **Connected agents**, which lists agents connected from outside the Playground. Select the **Agent Playground** tab to find your saved graphs. Click a row to open one; use Search and pagination to find it in a longer list.

Click **Create Agent** in the top right to start a new one. You land straight on an empty builder canvas for a brand-new agent. That agent already exists as an empty draft the moment the canvas opens.
To start a new graph, open **Create agents** in the top right, then choose **Playground**. Clicking the creation button alone only opens the menu. Choosing **Playground** creates the draft and opens its empty builder canvas.

<img src="/images/docs/agent-playground/guides/create-agent.png" alt="The Agent Playground list with five agents in the table, showing node count, creator, collaborators, and created and updated timestamps, with Create Agent in the top right" style={{ borderRadius: '5px' }} />
*An agent you never renamed keeps its generated timestamp name, which is what the **No. of nodes** column is for: it's the only thing in the row that tells you how much is in there*

<Note>
If **Create Agent** or, later, **Delete** looks greyed out, hover it: a tooltip explains why, either `You don't have permission to create agents.` or `You don't have permission to delete agents.`
The **Playground** menu option is disabled when you cannot create Playground agents. If **Delete** later looks greyed out, hover it for the permission tooltip.
</Note>

## Name your agent
Expand Down
26 changes: 23 additions & 3 deletions src/pages/docs/annotations/reference/sdk-api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,19 +33,39 @@ client = AnnotationQueue(
)
```

You can also set `FI_API_KEY` and `FI_SECRET_KEY` as environment variables and drop both arguments; the client picks them up automatically. Find both under **Settings → API Keys** in the platform.
You can also set `FI_API_KEY` and `FI_SECRET_KEY` as environment variables and drop both arguments; the client picks them up automatically. Create a pair from **Keys** under **Build** in the main sidebar ([API Keys](/docs/admin-settings/api-keys)).

## An end-to-end example

Creating `Support quality review`, pushing two traces into it, checking progress, then pulling the completed results back out:
Create a label and a queue, add two traces, activate the queue, then submit ratings and export the results. Replace the trace IDs with traces in your organization. The ratings below are examples; review each trace before submitting a real rating.

```python
queue = client.create(name="Support quality review", instructions="Rate response quality 1-5")
label = client.create_label(
name="Support quality",
type="star",
settings={"no_of_stars": 5},
)
queue = client.create(
name="Support quality review",
label_ids=[label.id],
instructions="Rate response quality 1-5",
auto_assign=True,
annotations_required=1,
requires_review=False,
)

client.add_items(queue.id, items=[
{"source_type": "trace", "source_id": "trace_abc123"},
{"source_type": "trace", "source_id": "trace_def456"},
])
client.activate(queue.id)

for item in client.list_items(queue.id):
client.submit_annotations(
queue.id,
item.id,
annotations=[{"label_id": label.id, "value": 4}],
)

progress = client.get_progress(queue.id)
print(f"{progress.completed} of {progress.total} done")
Expand Down
6 changes: 3 additions & 3 deletions src/pages/docs/api/dataset-evals/add-dataset-eval.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ description: "Add an evaluation to a dataset by selecting a template and configu
config: {},
params: {},
mapping: {
input: "question_column",
output: "response_column"
input: "11111111-1111-4111-8111-111111111111",
output: "22222222-2222-4222-8222-222222222222"
},
reason_column: true
},
Expand Down Expand Up @@ -67,7 +67,7 @@ description: "Add an evaluation to a dataset by selecting a template and configu
</ResponseField>

<ResponseField name="mapping" type="object">
Mapping of eval template variable keys to dataset column names.
Map each template input key (such as `input` or `output`) to a dataset column UUID, not a column name. Get column IDs from `GET /model-hub/dataset/columns/{dataset_id}/` and replace the example UUIDs with the IDs for your input and output columns.
</ResponseField>

<ResponseField name="reason_column" type="boolean">
Expand Down
6 changes: 3 additions & 3 deletions src/pages/docs/api/dataset-evals/edit-and-run-eval.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ description: "Update an evaluation's config and key mapping, then optionally re-
config: {},
params: {},
mapping: {
input: "question_column",
output: "response_column"
input: "11111111-1111-4111-8111-111111111111",
output: "22222222-2222-4222-8222-222222222222"
},
reason_column: true
},
Expand Down Expand Up @@ -66,7 +66,7 @@ description: "Update an evaluation's config and key mapping, then optionally re-
</ResponseField>

<ResponseField name="mapping" type="object">
Mapping of eval template variable keys to dataset column names.
Map each template input key (such as `input` or `output`) to a dataset column UUID, not a column name. Get column IDs from `GET /model-hub/dataset/columns/{dataset_id}/` and replace the example UUIDs with the IDs for your input and output columns.
</ResponseField>

<ResponseField name="reason_column" type="boolean">
Expand Down
6 changes: 3 additions & 3 deletions src/pages/docs/api/datasets/add-as-new.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ description: "Create a new dataset from selected columns of an existing dataset
dataset_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
name: "My New Dataset",
columns: {
"col-uuid-1": "input_text",
"col-uuid-2": "expected_output"
"550e8400-e29b-41d4-a716-446655440011": "input_text",
"550e8400-e29b-41d4-a716-446655440012": "expected_output"
}
}}
responseExample={{
Expand All @@ -38,7 +38,7 @@ description: "Create a new dataset from selected columns of an existing dataset
</ParamField>
<ParamField body="name" type="string" required>Name for the new dataset.</ParamField>
<ParamField body="columns" type="object" required>
Mapping of source column UUIDs to new column names.
A nonempty mapping from existing column UUIDs in the source dataset or experiment to new column names. Include at least one entry and use distinct new names. Keys must be bare UUIDs, without a `col-` prefix; replace the example UUIDs with your source column IDs. Omitting `columns` or sending `{}` returns `400 Bad Request`.
</ParamField>
</ApiSection>

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/api/datasets/run-prompt/get-model-voices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "Retrieve the available voice options for a specific model's audio
data: {
model_name: "gpt-4o-audio-preview",
provider: "openai",
custom_voice_supported: true,
custom_voice_supported: false,
supported_voices: [
{ id: "alloy", name: "Alloy", type: "system" },
{ id: "echo", name: "Echo", type: "system" },
Expand Down Expand Up @@ -54,7 +54,7 @@ description: "Retrieve the available voice options for a specific model's audio

<ResponseField name="provider" type="string">Model provider (e.g., `openai`, `elevenlabs`).</ResponseField>

<ResponseField name="custom_voice_supported" type="boolean">Whether the model supports custom voices.</ResponseField>
<ResponseField name="custom_voice_supported" type="boolean">`true` only when `provider` is `elevenlabs` or `cartesia`; `false` for `openai`. This capability flag is independent of any stored custom voice records included in `supported_voices`.</ResponseField>

<ResponseField name="supported_voices" type="array">Available voice objects.</ResponseField>
<ApiCollapsible title="Show 3 properties">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,16 @@ description: "Retrieve available models, tools, output formats, and tool choices
}
],
output_formats: [
{ value: "string", label: "String" },
{ value: "audio", label: "Audio" },
{ value: "json", label: "JSON" }
{ value: "array", label: "array" },
{ value: "string", label: "string" },
{ value: "number", label: "number" },
{ value: "object", label: "object" },
{ value: "audio", label: "audio" },
{ value: "image", label: "image" }
],
tool_choices: [
{ value: "auto", label: "Auto" },
{ value: "none", label: "None" },
{ value: "required", label: "Required" }
{ value: "auto", label: "auto" },
{ value: "required", label: "required" }
]
}
}}
Expand Down Expand Up @@ -87,9 +89,9 @@ description: "Retrieve available models, tools, output formats, and tool choices
<ResponseField name="description" type="string">Tool description.</ResponseField>
</ApiCollapsible>

<ResponseField name="output_formats" type="array">Supported output format options with `value` and `label`.</ResponseField>
<ResponseField name="output_formats" type="array">Supported output format options with `value` and `label`. Values are `array`, `string`, `number`, `object`, `audio` and `image`. Use `object`, not `json`, for structured object output.</ResponseField>

<ResponseField name="tool_choices" type="array">Supported tool choice options with `value` and `label`.</ResponseField>
<ResponseField name="tool_choices" type="array">Supported tool choice options with `value` and `label`. Only `auto` and `required` are returned. When adding or editing a run prompt column, `config.tool_choice` also accepts JSON `null` to clear the tool preference; the string `none` is not accepted or returned.</ResponseField>
</ApiCollapsible>
</ApiSection>

Expand Down
4 changes: 2 additions & 2 deletions src/pages/docs/billing/guides/control-spend.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Go to **Settings > Usage Summary**. The page shows one card per meter for the cu

*A fresh period: every meter still inside its free allowance, so the period total is just the platform fee*

Each card carries what you have used so far, the free allowance that usage counts against, the share of the allowance you have spent, the projected total by the end of the period, and the estimated cost with the tier bands that produced it. Above the cards sit your plan name, the platform fee, the start and end of the billing period, and the total estimated cost across every meter. Two filters narrow the view: one picks the period, the other scopes everything to a single workspace.
Each card carries what you have used so far, the free allowance that usage counts against, the share of the allowance you have spent, the projected total by the end of the period, and the estimated cost with the tier bands that produced it. Above the cards sit your plan name, the platform fee, the start and end of the billing period, and the total estimated cost across every meter. The period filter selects the time range for this organization-wide overview. To compare workspaces, select a meter and read its **Usage by workspace** breakdown.

Read the projection as a pace, not a promise. It extrapolates from how fast the meter has moved so far, so it shifts as the month goes on and is least reliable in the first few days, when a single busy afternoon can drag the whole line upward.

Expand All @@ -31,7 +31,7 @@ This is the view that answers whether a jump was one bad day or a new baseline.

## Split usage by workspace

Go to **Settings > Usage Summary**, open a meter's trend, then break it down by workspace for a period. This is distinct from the workspace filter on the overview page: the filter scopes the whole page to one workspace, while this view compares workspaces against each other for a single meter, telling you which team is driving the number rather than just how big it got.
Go to **Settings > Usage Summary**, choose a period and select a meter. Its **Usage by workspace** table compares workspaces for that meter and period, telling you which team is driving the number rather than just how big it got. The overview cards and totals remain organization-wide; there is no global workspace filter.

Reach for this before you set a budget. A ceiling on total spend catches everything but tells you nothing, while knowing which workspace is driving a meter tells you which meter is worth putting a ceiling on.

Expand Down
23 changes: 4 additions & 19 deletions src/pages/docs/command-center/admin/organizations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ Organizations can have multiple members with different roles.
|---|---|
| **Owner** | Full access. Can delete the org, manage billing, and change all settings. |
| **Admin** | Can manage providers, keys, routing, budgets, and members (except owner). |
| **Member** | Can view config and create API keys. Cannot change org settings. |
| **Viewer** | Read-only access to dashboard, logs, and analytics. |
| **Member** | Cannot write gateway configuration or provider credentials (`403`), but active members can create and revoke their own personal gateway keys through the signed-in dashboard. |
| **Viewer** | Read-only access to gateway configuration, logs, and analytics, plus personal-key self-service: active Viewers can create and revoke their own gateway keys through the signed-in dashboard. |

### Managing members

Expand All @@ -116,24 +116,9 @@ Members are managed through the Future AGI dashboard at **Settings > Members**.

Each organization has its own pool of API keys (virtual keys). Keys inherit org-level settings and can have additional per-key restrictions.

```python
# List keys for an org
keys = client.keys.list(org_id="your-org-id")
for key in keys:
print(f"{key.name}: {key.key_prefix}...")
To create a personal key, sign in and select your organization, then open **Gateway > API keys > Create key**. Enter a **Name**, optionally choose **Allowed models** and **Allowed providers**, and click **Create**. Copy the key from the one-time reveal and store it securely. Active Members and Viewers can also use this flow and revoke their own keys in the dashboard. Creating a key with `X-Api-Key` / `X-Secret-Key` returns `403`, including for Owners and Admins.

# Create a new key
new_key = client.keys.create(
org_id="your-org-id",
name="backend-service",
rate_limit_rpm=100,
allowed_models=["gpt-4o", "gpt-4o-mini"],
)
print(f"Key: {new_key.key}") # full key shown only at creation

# Revoke a key
client.keys.delete(key_id=new_key.id)
```
The [control-plane list and revoke examples](/docs/command-center/concepts/virtual-keys#creating-and-managing-keys) use a Future AGI user key and follow its owner's organization and workspace permissions. Owners and Admins can access organization keys; other members can access only their own. Use the dashboard for personal-key self-service without workspace write access.

See [Virtual keys & access control](/docs/command-center/concepts/virtual-keys) for detailed key configuration (RBAC, IP ACL, model restrictions).

Expand Down
Loading
Loading