Skip to content

Commit 5b7d1b6

Browse files
sivanel97sivanel97
committed
Added the 6 new routes to the AI folder of the API
1 parent 78bfa36 commit 5b7d1b6

10 files changed

+1973
-1
lines changed

‎docs/api-reference/change-a-specific-provider-configuration.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: change-a-specific-provider-configuration
3+
title: "Change a specific provider configuration"
4+
description: "This route allows you to change the configuration of a specific LLM provider."
5+
sidebar_label: "Change a specific provider configuration"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJztWd9z4jYQ/lc8mj60Uxwgk7zwRq59yDTXy+RyfcnRjrAXrItsuZLMHfH4f++ubIPBBpIec01v4CEYWbv69tP+kpKzEEygRWqFStiI3UfCeFplFjwupfpsvKXKPKu8IOLJHDwbgReoZCbmmeYk46mZxz2TQiBmIvBubt56qVYLEYI+Yz1m+dyw0QMbX7NJj2n4OwNjr1S4ZKOcoSILiaVHnqZSBE5j/5MhKDkzQQQxpye7TAHBqeknCCxqxRVS0FaAqdQgHqclWb6b4XJtCSuspIFxYiMUFkFLC0/Fb7B8D4EG+zuPobGusVokc5SIRXIDydxGbDQsitIeoSEkC1vyaC8PQ0EmcXnbWGvGpYGitxvkuxQSJOwVIxw/ZRq8Y+EkmEZlOoBnTg8hlWoZo+9ch1/NwtbqW9r/PUdXEGoVPLbpCQIwBjFchy/iyLjJ41r6hfzORRlU+yYiUm4taEoEfz5w/2mSnxe+e/jZ//gxzIfFDwy1zTOuQ82FvA6RJIx70G3VzXl/gDad67c2p5ObfbavbDuwURNcSS1Aa8xM5nBOiVUIsnNeE+48tf4ljgWSZyH4mLcSsP6Ffz44vxxcDi8I1KbeUuLg8pDwqYSmb0+VksAT554znknMmlZnQATu9c/d2L4diK973TsiEJqQco2Og25uXKVoVZlaN04VFAlYsvQSV0pcqLEFlyLkFv4KiNHA1c2mV6zyQkvxKuYgyWJyH4SXcIEDnNKpv/7ZKFLTdRZR2rJJjQojNVqDqkvuBhLHiKu6JlWJKTf1fDCgr82q/0tJondXzSSXPk5tVo/dzCImt2uH5FeGHZ/G3V5V9J7VU7y66vy9Afq++oJTF/DfdwG9ZjwnihJQcXCvDhSVyam3+D/3FrMZFfEFvD3tyjfbFcSoAXuocGy7stFM6ZjjG0Z9lm8FBvha5GrZmWWyNHypwkqkU+FWRmr0VzVHbdc5kHu2VKpHtmqDDkmS7MXraNwwy6nuPB9jVubzjjrkCrPFAtAZXd2G50UnX+Xqz6Pr4kTX8+m6PHnX8+lycGykQjp5Zc46Oo2NWH8x7EsZ+3W6MP28fixc/6IX9bEz0xIFImtTM+r3sfk8o4PJmVCM+pH228ysJ0xcK5RpYZfvifCS0ylwvdGClR3t+pA4zhCzFk+8OrO6c2QEnPIa2USbeLe+of31C49TCVs3rK0evrEPGz3QustZVcBVeXElZH+h2pxbNM9rlbRIZspZW9233SI93viW7iMXdafJhmcDQpYqY2PuXLQi4015n924uq53avN+21W+RlA0bq2Pf1le7puFL7afSi5cSDhXyCsPe2CLIU7c8DH8PVrVJ3SNCG2lmXk+5QY+aFkUNFxeY5DrhcJUTDqP7rFH9JJdFxs4mhEo53ULrgWJdqvZydOPd1Wk/eTtsrJ22WTZXLOGtjLPtdqVyxKG8vWbciX/npSsxVsJiiKrlKAzRGr3zp00gvz2wz3dIVT/tiDPxkHNP1MFx78OqXKGO4d3YzmT6ASZy1msVEmffwCek+JV
9+
sidebar_class_name: "put api-method"
10+
info_path: api-reference/port-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Change a specific provider configuration"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"put"}
31+
path={"/v1/llm-providers/{provider}"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
This route allows you to change the configuration of a specific LLM provider.
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={[{"schema":{"type":"boolean"},"in":"query","name":"validate_connection","required":false},{"schema":{"type":"string","enum":["openai","azure-openai","anthropic","bedrock","port"]},"in":"path","name":"provider","required":true}]}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"config":{"anyOf":[{"type":"object","title":"Anthropic","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","title":"OpenAI","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","title":"Azure OpenAI","properties":{"apiKeySecretName":{"type":"string","minLength":1},"resourceName":{"type":"string","minLength":1},"deploymentId":{"type":"string","minLength":1}},"required":["apiKeySecretName","resourceName","deploymentId"],"additionalProperties":false},{"type":"object","title":"Bedrock","properties":{"accessKeyIdSecretName":{"type":"string","minLength":1},"secretAccessKeySecretName":{"type":"string","minLength":1},"region":{"type":"string","minLength":1,"pattern":"^[a-z]{2}-[a-z]+-\\d{1}$"},"guardrailIdentifier":{"type":"string"},"guardrailVersion":{"type":"string"}},"required":["accessKeyIdSecretName","secretAccessKeySecretName","region"],"additionalProperties":false}]},"overrides":{"type":"object","properties":{"models":{"type":"object","required":["gpt-5","claude-sonnet-4-20250514"],"properties":{"gpt-5":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-sonnet-4-20250514":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"enabled":{"type":"boolean","default":true}},"additionalProperties":false}}}}}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"result":{"type":"object","properties":{"provider":{"type":"string","enum":["openai","azure-openai","anthropic","bedrock","port"]},"enabled":{"type":"boolean"},"config":{"anyOf":[{"type":"object","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","properties":{"apiKeySecretName":{"type":"string","minLength":1}},"required":["apiKeySecretName"],"additionalProperties":false},{"type":"object","properties":{"apiKeySecretName":{"type":"string","minLength":1},"resourceName":{"type":"string","minLength":1},"deploymentId":{"type":"string","minLength":1}},"required":["apiKeySecretName","resourceName","deploymentId"],"additionalProperties":false},{"type":"object","properties":{"accessKeyIdSecretName":{"type":"string","minLength":1},"secretAccessKeySecretName":{"type":"string","minLength":1},"region":{"type":"string","minLength":1,"pattern":"^[a-z]{2}-[a-z]+-\\d{1}$"},"guardrailIdentifier":{"type":"string"},"guardrailVersion":{"type":"string"}},"required":["accessKeyIdSecretName","secretAccessKeySecretName","region"],"additionalProperties":false},{"anyOf":[{"not":{}},{"type":"object","properties":{},"additionalProperties":false}]}]},"overrides":{"type":"object","properties":{"models":{"type":"object","required":["gpt-5","claude-sonnet-4-20250514"],"properties":{"gpt-5":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-sonnet-4-20250514":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false}},"additionalProperties":false}},"additionalProperties":false},"effectiveModels":{"type":"object","required":["gpt-5","claude-sonnet-4-20250514"],"properties":{"gpt-5":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false},"claude-sonnet-4-20250514":{"type":"object","properties":{"enabled":{"type":"boolean","default":true}},"additionalProperties":false}},"additionalProperties":false},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"}},"required":["provider","enabled","effectiveModels"],"additionalProperties":false}},"required":["ok","result"],"additionalProperties":false}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

‎docs/api-reference/change-default-llm-provider-and-model.api.mdx‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
id: change-default-llm-provider-and-model
3+
title: "Change default LLM provider and model"
4+
description: "This route allows you to change the default LLM provider and model."
5+
sidebar_label: "Change default LLM provider and model"
6+
hide_title: true
7+
hide_table_of_contents: true
8+
api: eJzVVTtv2zAQ/isCZ8uPIF68uY8haAoYaTIZHs7S2WJCiSx5dOII/u+9k5TaboUERTO0HmTyeO/vO7JWOYbMa0faVmqmbgsdEm8jYQLG2MeQ7G1MyCZZAdUWEyowyXED0VByff01cd7udI4+gSpPSpujGaqBItgGNVuq+ZVaDZTH7xEDfbD5Xs1qldmKsCJZgnNGZyCxR/dBEqhVyAosQVa0d8gp2fU9ZsReOZZDTxqDnL5EPtEM5HW1ZU2sYinxWb8CzQJ4jh7T47aigp3pjNdrzL3NHsS/9aRWh4Fq6njN79ZROuV9ZiDmmHLmFVJ6mV6ML6bj6eSSvRzaurXHXCx+ZvvinfsCea6ldDCLk8o2YAIezu3JR2wEwdkqtPVfjMfydw7fpw6am05TcnyfdtuHE521tQahUm1OHPC/h4sPPQJhPqc+TxvrS+ATlbNOSrpEdTT5sP/dhE+jy//UYWfS6/BvCXVubqWDHXZvUpFtp/8G29B720MhIQGGAFvsPcuRQJvQF7a/8PrQ2682+tvtatKhwrKlcrGpDqjgzWg3GRlTpi/ghVF3lwbWCeh3LOJotYqeCa0KIhdmoxE4PRS2D7XlcvpOYzgqrMRVFr2m/Tdpd9vRNYI/mz42+4J7jltBKft55Iy9fm4AY7EWhAsE4ZhUJBDeHG/yz09QOoPno32c4G4mu9E7iLuNbaJrEiu14HST+eKKdaXqllCT4Vh0nQ1UQkOYLrmP7evz+sujBuf8PHlq3utda1tH+EQjZ0A3nGzQqDuIl2o3YcUzkJu8OpgZnIKrE8W6XkPAO28OBxFzZz3P/ZKXO/Aa1tKmpdxMHQjCiwdGjLvRlpXeSjqibmKL6C8DJ1xpLeZZho5e1V2dkHZxdytXbfdgS/ks9PAodwZ/Z4oXtulyw61GVivDnYzNDKrWpfx+AA+Z4Wc=
9+
sidebar_class_name: "put api-method"
10+
info_path: api-reference/port-api
11+
custom_edit_url: null
12+
---
13+
14+
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
15+
import ParamsDetails from "@theme/ParamsDetails";
16+
import RequestSchema from "@theme/RequestSchema";
17+
import StatusCodes from "@theme/StatusCodes";
18+
import OperationTabs from "@theme/OperationTabs";
19+
import TabItem from "@theme/TabItem";
20+
import Heading from "@theme/Heading";
21+
22+
<Heading
23+
as={"h1"}
24+
className={"openapi__heading"}
25+
children={"Change default LLM provider and model"}
26+
>
27+
</Heading>
28+
29+
<MethodEndpoint
30+
method={"put"}
31+
path={"/v1/llm-providers/defaults"}
32+
context={"endpoint"}
33+
>
34+
35+
</MethodEndpoint>
36+
37+
38+
39+
This route allows you to change the default LLM provider and model.
40+
41+
<Heading
42+
id={"request"}
43+
as={"h2"}
44+
className={"openapi-tabs__heading"}
45+
children={"Request"}
46+
>
47+
</Heading>
48+
49+
<ParamsDetails
50+
parameters={undefined}
51+
>
52+
53+
</ParamsDetails>
54+
55+
<RequestSchema
56+
title={"Body"}
57+
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","enum":["openai","azure-openai","anthropic","bedrock","port"]},"model":{"type":"string","enum":["gpt-5","claude-sonnet-4-20250514"]}},"required":["provider","model"],"additionalProperties":false}}},"required":true}}
58+
>
59+
60+
</RequestSchema>
61+
62+
<StatusCodes
63+
id={undefined}
64+
label={undefined}
65+
responses={{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"result":{"type":"object","properties":{"provider":{"type":"string","enum":["openai","azure-openai","anthropic","bedrock","port"]},"model":{"type":"string","enum":["gpt-5","claude-sonnet-4-20250514"]},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"type":"string"}},"required":["provider","model"],"additionalProperties":false}},"required":["ok","result"],"additionalProperties":false}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"error":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}}},"required":["ok","error"],"additionalProperties":false}}}}}}
66+
>
67+
68+
</StatusCodes>
69+
70+
71+

0 commit comments

Comments
 (0)