Files
goose/api_clients/bash/docs/SuperRoutesConfigManagementApi.md
2025-10-02 20:13:20 -04:00

10 KiB

SuperRoutesConfigManagementApi

All URIs are relative to **

Method HTTP request Description
addExtension POST /config/extensions
backupConfig POST /config/backup
createCustomProvider POST /config/custom-providers
getExtensions GET /config/extensions
getProviderModels GET /config/providers/{name}/models
initConfig POST /config/init
providers GET /config/providers
readAllConfig GET /config
readConfig POST /config/read
recoverConfig POST /config/recover
removeConfig POST /config/remove
removeCustomProvider DELETE /config/custom-providers/{id}
removeExtension DELETE /config/extensions/{name}
upsertConfig POST /config/upsert
upsertPermissions POST /config/permissions
validateConfig GET /config/validate

addExtension

Example

goose-api addExtension

Parameters

Name Type Description Notes
extensionQuery ExtensionQuery

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

backupConfig

Example

goose-api backupConfig

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createCustomProvider

Example

goose-api createCustomProvider

Parameters

Name Type Description Notes
createCustomProviderRequest CreateCustomProviderRequest

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getExtensions

Example

goose-api getExtensions

Parameters

This endpoint does not need any parameter.

Return type

ExtensionResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getProviderModels

Example

goose-api getProviderModels name=value

Parameters

Name Type Description Notes
name string Provider name (e.g., openai) [default to null]

Return type

array[string]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

initConfig

Example

goose-api initConfig

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

providers

Example

goose-api providers

Parameters

This endpoint does not need any parameter.

Return type

array[ProviderDetails]

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

readAllConfig

Example

goose-api readAllConfig

Parameters

This endpoint does not need any parameter.

Return type

ConfigResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

readConfig

Example

goose-api readConfig

Parameters

Name Type Description Notes
configKeyQuery ConfigKeyQuery

Return type

AnyType

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

recoverConfig

Example

goose-api recoverConfig

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeConfig

Example

goose-api removeConfig

Parameters

Name Type Description Notes
configKeyQuery ConfigKeyQuery

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeCustomProvider

Example

goose-api removeCustomProvider id=value

Parameters

Name Type Description Notes
id string [default to null]

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

removeExtension

Example

goose-api removeExtension name=value

Parameters

Name Type Description Notes
name string [default to null]

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upsertConfig

Example

goose-api upsertConfig

Parameters

Name Type Description Notes
upsertConfigQuery UpsertConfigQuery

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upsertPermissions

Example

goose-api upsertPermissions

Parameters

Name Type Description Notes
upsertPermissionsQuery UpsertPermissionsQuery

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validateConfig

Example

goose-api validateConfig

Parameters

This endpoint does not need any parameter.

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]