This API is accessible only from Forge applications and requires platform-provided authentication headers. It enables Forge apps to interact with native Forge-supported LLMs. For more information, see the Forge LLMs documentation
Returns the list of supported AI models and their respective statuses
string
RequiredSupported AI models and their respective statuses retrieved successfully
Response Payload from LLM list requests
1
2
3
4
curl --request GET \
--url '{FORGE_EGRESS_PROXY_URL}/forge/llm' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123'1
2
3
4
5
6
7
8
{
"models": [
{
"model": "claude-sonnet-4-20250514",
"status": "active"
}
]
}Proxy endpoint to make requests to the native Forge supported LLMs.
LLM
Requiredstring
Requiredarray<oneOf [System message, User message, Assistant message, Tool message]>
Requirednumber
number
number
array<LLMTool>
oneOf [string, LLMToolObject]
boolean
Successful response
Response Payload from LLM requests
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
curl --request POST \
--url '{FORGE_EGRESS_PROXY_URL}/forge/llm/{model}' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
--header 'Content-Type: application/json' \
--data '{
"messages": [
{
"role": "system",
"content": "You are a helpful assistant."
},
{
"role": "user",
"content": [
{
"type": "text",
"text": "What is the weather like in Melbourne?"
}
]
}
],
"max_completion_tokens": 1000,
"temperature": 0.7,
"tools": [
{
"type": "function",
"function": {
"name": "get_current_weather",
"description": "Get the current weather in a given location",
"parameters": {
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "The city and state, e.g. Sydney, NSW"
},
"unit": {
"type": "string",
"enum": [
"celsius",
"fahrenheit"
],
"description": "The unit of temperature"
}
},
"required": [
"location"
]
}
}
}
],
"tool_choice": "auto"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
{
"choices": [
{
"message": {
"role": "assistant",
"content": [
{
"type": "text",
"text": "To help you with the current weather in Melbourne, I will use the get_current_weather function."
}
],
"tool_calls": [
{
"id": "tooluse_BnyEynAYSwmA4rAjNy6sUA",
"type": "function",
"function": {
"name": "get_current_weather",
"arguments": "{\"location\": \"Melbourne\", \"unit\": \"Celsius\"}"
}
}
]
},
"finish_reason": "stop",
"index": 0
}
],
"usage": {
"input_tokens": 10,
"output_tokens": 15,
"total_tokens": 25
}
}Rate this page: