API reference

• System
  • getHealth Check
• CodeGate API
  • getList Provider Endpoints
  • postAdd Provider Endpoint
  • getList All Models For All Providers
  • getList Models By Provider
  • getGet Provider Endpoint
  • putUpdate Provider Endpoint
  • delDelete Provider Endpoint
  • putConfigure Auth Material
  • getList Workspaces
  • postCreate Workspace
  • getList Active Workspaces
  • postActivate Workspace
  • putUpdate Workspace
  • delDelete Workspace
  • getGet Workspace By Name
  • getList Archived Workspaces
  • postRecover Workspace
  • delHard Delete Workspace
  • getGet Workspace Alerts
  • getGet Workspace Alerts Summary
  • getGet Workspace Messages
  • getGet Messages By Prompt Id
  • getGet Workspace Custom Instructions
  • putSet Workspace Custom Instructions
  • delDelete Workspace Custom Instructions
  • getGet Workspace Muxes
  • putSet Workspace Muxes
  • getStream Sse
  • getVersion Check
  • getGet Workspace Token Usage
  • getList Personas
  • postCreate Persona
  • getGet Persona
  • putUpdate Persona
  • delDelete Persona
• Providers
  • getList Provider Endpoints
  • postAdd Provider Endpoint
  • getList All Models For All Providers
  • getList Models By Provider
  • getGet Provider Endpoint
  • putUpdate Provider Endpoint
  • delDelete Provider Endpoint
  • putConfigure Auth Material
• Workspaces
  • getList Workspaces
  • postCreate Workspace
  • getList Active Workspaces
  • postActivate Workspace
  • putUpdate Workspace
  • delDelete Workspace
  • getGet Workspace By Name
  • getList Archived Workspaces
  • postRecover Workspace
  • delHard Delete Workspace
  • getGet Workspace Alerts
  • getGet Workspace Alerts Summary
  • getGet Workspace Messages
  • getGet Messages By Prompt Id
  • getGet Workspace Custom Instructions
  • putSet Workspace Custom Instructions
  • delDelete Workspace Custom Instructions
  • getGet Workspace Muxes
  • putSet Workspace Muxes
  • getGet Workspace Token Usage
• Muxes
  • getGet Workspace Muxes
  • putSet Workspace Muxes
• Dashboard
  • getStream Sse
  • getVersion Check
• Token Usage
  • getGet Workspace Token Usage
• Personas
  • getList Personas
  • postCreate Persona
  • getGet Persona
  • putUpdate Persona
  • delDelete Persona

API docs by Redocly

CodeGate (0.1.7)

Download OpenAPI specification:Download

Generative AI CodeGen security gateway

System

Health Check

Responses

http://localhost:8989/health

Response samples

• 200

Content type

application/json

null

CodeGate API

List Provider Endpoints

List all provider endpoints.

query Parameters

Name (string) or Name (null) (Name)

Responses

http://localhost:8989/api/v1/provider-endpoints

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "id": "",
  • "name": "string",
  • "description": "",
  • "provider_type": "openai",
  • "endpoint": "",
  • "auth_type": "none"

  }

]

Add Provider Endpoint

Add a provider endpoint.

Request Body schema: application/json

required

	Id (string) or Id (null) (Id) Default: ""
name required	string (Name) >= 3 characters
description	string (Description) Default: ""
provider_type required	string (ProviderType) Enum: "openai" "anthropic" "vllm" "ollama" "lm_studio" "llamacpp" "openrouter" Represents the different types of providers we support.
endpoint	string (Endpoint) Default: ""
auth_type	string (ProviderAuthType) Default: "none" Enum: "none" "passthrough" "api_key" Represents the different types of auth we support for providers.
	Api Key (string) or Api Key (null) (Api Key)

Responses

http://localhost:8989/api/v1/provider-endpoints

Request samples

• Payload

Content type

application/json

{

• "id": "",
• "name": "string",
• "description": "",
• "provider_type": "openai",
• "endpoint": "",
• "auth_type": "none",
• "api_key": "string"

}

Response samples

• 201
• 422

Content type

application/json

{

• "id": "",
• "name": "string",
• "description": "",
• "provider_type": "openai",
• "endpoint": "",
• "auth_type": "none"

}

List All Models For All Providers

List all models for all providers.

Responses

http://localhost:8989/api/v1/provider-endpoints/models

Response samples

• 200

Content type

application/json

[

• {

  • "name": "string",
  • "provider_type": "openai",
  • "provider_name": "string"

  }

]

List Models By Provider

List models by provider.

path Parameters

provider_name required

string (Provider Name)

Responses

http://localhost:8989/api/v1/provider-endpoints/{provider_name}/models

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "name": "string",
  • "provider_type": "openai",
  • "provider_name": "string"

  }

]

Get Provider Endpoint

Get a provider endpoint by name.

path Parameters

provider_name required

string (Provider Name)

Responses

http://localhost:8989/api/v1/provider-endpoints/{provider_name}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "",
• "name": "string",
• "description": "",
• "provider_type": "openai",
• "endpoint": "",
• "auth_type": "none"

}

Update Provider Endpoint

Update a provider endpoint by name.

path Parameters

provider_name required

string (Provider Name)

Request Body schema: application/json

required

	Id (string) or Id (null) (Id) Default: ""
name required	string (Name) >= 3 characters
description	string (Description) Default: ""
provider_type required	string (ProviderType) Enum: "openai" "anthropic" "vllm" "ollama" "lm_studio" "llamacpp" "openrouter" Represents the different types of providers we support.
endpoint	string (Endpoint) Default: ""
auth_type	string (ProviderAuthType) Default: "none" Enum: "none" "passthrough" "api_key" Represents the different types of auth we support for providers.

Responses

http://localhost:8989/api/v1/provider-endpoints/{provider_name}

Request samples

• Payload

Content type

application/json

{

• "id": "",
• "name": "string",
• "description": "",
• "provider_type": "openai",
• "endpoint": "",
• "auth_type": "none"

}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "",
• "name": "string",
• "description": "",
• "provider_type": "openai",
• "endpoint": "",
• "auth_type": "none"

}

Delete Provider Endpoint

Delete a provider endpoint by name.

path Parameters

provider_name required

string (Provider Name)

Responses

http://localhost:8989/api/v1/provider-endpoints/{provider_name}

Response samples

• 200
• 422

Content type

application/json

null

Configure Auth Material

Configure auth material for a provider.

path Parameters

provider_name required

string (Provider Name)

Request Body schema: application/json

required

auth_type required	string (ProviderAuthType) Enum: "none" "passthrough" "api_key" Represents the different types of auth we support for providers.
	Api Key (string) or Api Key (null) (Api Key)

Responses

http://localhost:8989/api/v1/provider-endpoints/{provider_name}/auth-material

Request samples

• Payload

Content type

application/json

{

• "auth_type": "none",
• "api_key": "string"

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

List Workspaces

List all workspaces.

Args: provider_name (Optional[str]): Filter workspaces by provider name. If provided, will return workspaces where models from the specified provider (e.g., OpenAI, Anthropic) have been used in workspace muxing rules.

Returns: ListWorkspacesResponse: A response object containing the list of workspaces.

query Parameters

Provider Name (string) or Provider Name (null) (Provider Name)

Responses

http://localhost:8989/api/v1/workspaces

Response samples

• 200
• 422

Content type

application/json

{

• "workspaces": [

  • {

    • "name": "string",
    • "is_active": true

    }

  ]

}

Create Workspace

Create a new workspace.

Request Body schema: application/json

required

name required	string (Name)
	WorkspaceConfig (object) or null

Responses

http://localhost:8989/api/v1/workspaces

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "config": {

  • "custom_instructions": "string",
  • "muxing_rules": [

    • {

      • "provider_name": "string",
      • "provider_type": "openai",
      • "model": "string",
      • "matcher_type": "catch_all",
      • "matcher": "string"

      }

    ]

  }

}

Response samples

• 201
• 422

Content type

application/json

{

• "name": "string",
• "config": {

  • "custom_instructions": "string",
  • "muxing_rules": [

    • {

      • "provider_name": "string",
      • "provider_type": "openai",
      • "model": "string",
      • "matcher_type": "catch_all",
      • "matcher": "string"

      }

    ]

  }

}

List Active Workspaces

List all active workspaces.

In it's current form, this function will only return one workspace. That is, the globally active workspace.

Responses

http://localhost:8989/api/v1/workspaces/active

Response samples

• 200

Content type

application/json

{

• "workspaces": [

  • {

    • "name": "string",
    • "is_active": true,
    • "last_updated": null

    }

  ]

}

Activate Workspace

Activate a workspace by name.

query Parameters

status_code

any (Status Code) Default: 204

Request Body schema: application/json

required

name required

string (Name)

Responses

http://localhost:8989/api/v1/workspaces/active

Request samples

• Payload

Content type

application/json

{

• "name": "string"

}

Response samples

• 200
• 422

Content type

application/json

null

Update Workspace

Update a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Request Body schema: application/json

required

name required	string (Name)
	WorkspaceConfig (object) or null

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "config": {

  • "custom_instructions": "string",
  • "muxing_rules": [

    • {

      • "provider_name": "string",
      • "provider_type": "openai",
      • "model": "string",
      • "matcher_type": "catch_all",
      • "matcher": "string"

      }

    ]

  }

}

Response samples

• 200
• 422

Content type

application/json

{

• "name": "string",
• "config": {

  • "custom_instructions": "string",
  • "muxing_rules": [

    • {

      • "provider_name": "string",
      • "provider_type": "openai",
      • "model": "string",
      • "matcher_type": "catch_all",
      • "matcher": "string"

      }

    ]

  }

}

Delete Workspace

Delete a workspace by name.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}

Response samples

• 200
• 422

Content type

application/json

null

Get Workspace By Name

List workspaces by provider ID.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}

Response samples

• 200
• 422

Content type

application/json

{

• "name": "string",
• "config": {

  • "custom_instructions": "string",
  • "muxing_rules": [

    • {

      • "provider_name": "string",
      • "provider_type": "openai",
      • "model": "string",
      • "matcher_type": "catch_all",
      • "matcher": "string"

      }

    ]

  }

}

List Archived Workspaces

List all archived workspaces.

Responses

http://localhost:8989/api/v1/workspaces/archive

Response samples

• 200

Content type

application/json

{

• "workspaces": [

  • {

    • "name": "string",
    • "is_active": true

    }

  ]

}

Recover Workspace

Recover an archived workspace by name.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/archive/{workspace_name}/recover

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Hard Delete Workspace

Hard delete an archived workspace by name.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/archive/{workspace_name}

Response samples

• 200
• 422

Content type

application/json

null

Get Workspace Alerts

Get alerts for a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/alerts

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "conversation": {

    • "question_answers": [

      • {

        • "question": {

          • "message": "string",
          • "timestamp": "2019-08-24T14:15:22Z",
          • "message_id": "string"

          },
        • "answer": {

          • "message": "string",
          • "timestamp": "2019-08-24T14:15:22Z",
          • "message_id": "string"

          }

        }

      ],
    • "provider": "string",
    • "type": "chat",
    • "chat_id": "string",
    • "conversation_timestamp": "2019-08-24T14:15:22Z",
    • "token_usage_agg": {

      • "tokens_by_model": {

        • "property1": {

          • "provider_type": "openai",
          • "model": "string",
          • "token_usage": {

            • "input_tokens": 0,
            • "output_tokens": 0,
            • "input_cost": 0,
            • "output_cost": 0

            }

          },
        • "property2": {

          • "provider_type": "openai",
          • "model": "string",
          • "token_usage": {

            • "input_tokens": 0,
            • "output_tokens": 0,
            • "input_cost": 0,
            • "output_cost": 0

            }

          }

        },
      • "token_usage": {

        • "input_tokens": 0,
        • "output_tokens": 0,
        • "input_cost": 0,
        • "output_cost": 0

        }

      },
    • "alerts": [ ]

    },
  • "alert_id": "string",
  • "code_snippet": {

    • "code": "string",
    • "language": "string",
    • "filepath": "string",
    • "libraries": [ ],
    • "file_extension": "string"

    },
  • "trigger_string": "string",
  • "trigger_type": "string",
  • "trigger_category": "string",
  • "timestamp": "2019-08-24T14:15:22Z"

  }

]

Get Workspace Alerts Summary

Get alert summary for a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/alerts-summary

Response samples

• 200
• 422

Content type

application/json

{

• "malicious_packages": 0,
• "pii": 0,
• "secrets": 0,
• "total_alerts": 0

}

Get Workspace Messages

Get messages for a workspace.

path Parameters

workspace_name required

string (Workspace Name)

query Parameters

page	integer (Page) >= 1 Default: 1
page_size	integer (Page Size) [ 1 .. 100 ] Default: 50
	Array of Filter By Ids (strings) or Filter By Ids (null) (Filter By Ids)
	Array of Filter By Alert Trigger Types (strings) or Filter By Alert Trigger Types (null) (Filter By Alert Trigger Types)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/messages

Response samples

• 200
• 422

Content type

application/json

{

• "data": [

  • {

    • "chat_id": "string",
    • "prompt": {

      • "message": "string",
      • "timestamp": "2019-08-24T14:15:22Z",
      • "message_id": "string"

      },
    • "alerts_summary": {

      • "malicious_packages": 0,
      • "pii": 0,
      • "secrets": 0,
      • "total_alerts": 0

      },
    • "token_usage_agg": {

      • "tokens_by_model": {

        • "property1": {

          • "provider_type": "openai",
          • "model": "string",
          • "token_usage": {

            • "input_tokens": 0,
            • "output_tokens": 0,
            • "input_cost": 0,
            • "output_cost": 0

            }

          },
        • "property2": {

          • "provider_type": "openai",
          • "model": "string",
          • "token_usage": {

            • "input_tokens": 0,
            • "output_tokens": 0,
            • "input_cost": 0,
            • "output_cost": 0

            }

          }

        },
      • "token_usage": {

        • "input_tokens": 0,
        • "output_tokens": 0,
        • "input_cost": 0,
        • "output_cost": 0

        }

      },
    • "provider": "string",
    • "type": "chat",
    • "conversation_timestamp": "2019-08-24T14:15:22Z"

    }

  ],
• "limit": 0,
• "offset": 0,
• "total": 0

}

Get Messages By Prompt Id

Get messages for a workspace.

path Parameters

workspace_name required	string (Workspace Name)
prompt_id required	string (Prompt Id)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/messages/{prompt_id}

Response samples

• 200
• 422

Content type

application/json

{

• "question_answers": [

  • {

    • "question": {

      • "message": "string",
      • "timestamp": "2019-08-24T14:15:22Z",
      • "message_id": "string"

      },
    • "answer": {

      • "message": "string",
      • "timestamp": "2019-08-24T14:15:22Z",
      • "message_id": "string"

      }

    }

  ],
• "provider": "string",
• "type": "chat",
• "chat_id": "string",
• "conversation_timestamp": "2019-08-24T14:15:22Z",
• "token_usage_agg": {

  • "tokens_by_model": {

    • "property1": {

      • "provider_type": "openai",
      • "model": "string",
      • "token_usage": {

        • "input_tokens": 0,
        • "output_tokens": 0,
        • "input_cost": 0,
        • "output_cost": 0

        }

      },
    • "property2": {

      • "provider_type": "openai",
      • "model": "string",
      • "token_usage": {

        • "input_tokens": 0,
        • "output_tokens": 0,
        • "input_cost": 0,
        • "output_cost": 0

        }

      }

    },
  • "token_usage": {

    • "input_tokens": 0,
    • "output_tokens": 0,
    • "input_cost": 0,
    • "output_cost": 0

    }

  },
• "alerts": [ ]

}

Get Workspace Custom Instructions

Get the custom instructions of a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/custom-instructions

Response samples

• 200
• 422

Content type

application/json

{

• "prompt": "string"

}

Set Workspace Custom Instructions

path Parameters

workspace_name required

string (Workspace Name)

Request Body schema: application/json

required

prompt required

string (Prompt)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/custom-instructions

Request samples

• Payload

Content type

application/json

{

• "prompt": "string"

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Delete Workspace Custom Instructions

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/custom-instructions

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Get Workspace Muxes

Get the mux rules of a workspace.

The list is ordered in order of priority. That is, the first rule in the list has the highest priority.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/muxes

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "provider_name": "string",
  • "provider_type": "openai",
  • "model": "string",
  • "matcher_type": "catch_all",
  • "matcher": "string"

  }

]

Set Workspace Muxes

Set the mux rules of a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Request Body schema: application/json

required

Array

provider_name required	string (Provider Name)
provider_type required	string (ProviderType) Enum: "openai" "anthropic" "vllm" "ollama" "lm_studio" "llamacpp" "openrouter" Represents the different types of providers we support.
model required	string (Model)
matcher_type required	string (MuxMatcherType) Enum: "catch_all" "filename_match" "fim_filename" "chat_filename" Represents the different types of matchers we support. The 3 rules present match filenames and request types. They're used in conjunction with the matcher field in the MuxRule model. E.g. catch_all-> Always match filename_match and match: requests.py -> Match the request if the filename is requests.py fim_filename and match: main.py -> Match the request if the request type is fim and the filename is main.py NOTE: Removing or updating fields from this enum will require a migration. Adding new fields is safe.
	Matcher (string) or Matcher (null) (Matcher)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/muxes

Request samples

• Payload

Content type

application/json

[

• {

  • "provider_name": "string",
  • "provider_type": "openai",
  • "model": "string",
  • "matcher_type": "catch_all",
  • "matcher": "string"

  }

]

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Stream Sse

Send alerts event

Responses

http://localhost:8989/api/v1/alerts_notification

Response samples

• 200

Content type

application/json

null

Version Check

Responses

http://localhost:8989/api/v1/version

Response samples

• 200

Content type

application/json

null

Get Workspace Token Usage

Get the token usage of a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/token-usage

Response samples

• 200
• 422

Content type

application/json

{

• "tokens_by_model": {

  • "property1": {

    • "provider_type": "openai",
    • "model": "string",
    • "token_usage": {

      • "input_tokens": 0,
      • "output_tokens": 0,
      • "input_cost": 0,
      • "output_cost": 0

      }

    },
  • "property2": {

    • "provider_type": "openai",
    • "model": "string",
    • "token_usage": {

      • "input_tokens": 0,
      • "output_tokens": 0,
      • "input_cost": 0,
      • "output_cost": 0

      }

    }

  },
• "token_usage": {

  • "input_tokens": 0,
  • "output_tokens": 0,
  • "input_cost": 0,
  • "output_cost": 0

  }

}

List Personas

List all personas.

Responses

http://localhost:8989/api/v1/personas

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "description": "string"

  }

]

Create Persona

Create a new persona.

Request Body schema: application/json

required

name required	string (Name)
description required	string (Description)

Responses

http://localhost:8989/api/v1/personas

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "description": "string"

}

Response samples

• 201
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string"

}

Get Persona

Get a persona by name.

path Parameters

persona_name required

string (Persona Name)

Responses

http://localhost:8989/api/v1/personas/{persona_name}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string"

}

Update Persona

Update an existing persona.

path Parameters

persona_name required

string (Persona Name)

Request Body schema: application/json

required

new_name required	string (New Name)
new_description required	string (New Description)

Responses

http://localhost:8989/api/v1/personas/{persona_name}

Request samples

• Payload

Content type

application/json

{

• "new_name": "string",
• "new_description": "string"

}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string"

}

Delete Persona

Delete a persona.

path Parameters

persona_name required

string (Persona Name)

Responses

http://localhost:8989/api/v1/personas/{persona_name}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Providers

List Provider Endpoints

List all provider endpoints.

query Parameters

Name (string) or Name (null) (Name)

Responses

http://localhost:8989/api/v1/provider-endpoints

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "id": "",
  • "name": "string",
  • "description": "",
  • "provider_type": "openai",
  • "endpoint": "",
  • "auth_type": "none"

  }

]

Add Provider Endpoint

Add a provider endpoint.

Request Body schema: application/json

required

	Id (string) or Id (null) (Id) Default: ""
name required	string (Name) >= 3 characters
description	string (Description) Default: ""
provider_type required	string (ProviderType) Enum: "openai" "anthropic" "vllm" "ollama" "lm_studio" "llamacpp" "openrouter" Represents the different types of providers we support.
endpoint	string (Endpoint) Default: ""
auth_type	string (ProviderAuthType) Default: "none" Enum: "none" "passthrough" "api_key" Represents the different types of auth we support for providers.
	Api Key (string) or Api Key (null) (Api Key)

Responses

http://localhost:8989/api/v1/provider-endpoints

Request samples

• Payload

Content type

application/json

{

• "id": "",
• "name": "string",
• "description": "",
• "provider_type": "openai",
• "endpoint": "",
• "auth_type": "none",
• "api_key": "string"

}

Response samples

• 201
• 422

Content type

application/json

{

• "id": "",
• "name": "string",
• "description": "",
• "provider_type": "openai",
• "endpoint": "",
• "auth_type": "none"

}

List All Models For All Providers

List all models for all providers.

Responses

http://localhost:8989/api/v1/provider-endpoints/models

Response samples

• 200

Content type

application/json

[

• {

  • "name": "string",
  • "provider_type": "openai",
  • "provider_name": "string"

  }

]

List Models By Provider

List models by provider.

path Parameters

provider_name required

string (Provider Name)

Responses

http://localhost:8989/api/v1/provider-endpoints/{provider_name}/models

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "name": "string",
  • "provider_type": "openai",
  • "provider_name": "string"

  }

]

Get Provider Endpoint

Get a provider endpoint by name.

path Parameters

provider_name required

string (Provider Name)

Responses

http://localhost:8989/api/v1/provider-endpoints/{provider_name}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "",
• "name": "string",
• "description": "",
• "provider_type": "openai",
• "endpoint": "",
• "auth_type": "none"

}

Update Provider Endpoint

Update a provider endpoint by name.

path Parameters

provider_name required

string (Provider Name)

Request Body schema: application/json

required

	Id (string) or Id (null) (Id) Default: ""
name required	string (Name) >= 3 characters
description	string (Description) Default: ""
provider_type required	string (ProviderType) Enum: "openai" "anthropic" "vllm" "ollama" "lm_studio" "llamacpp" "openrouter" Represents the different types of providers we support.
endpoint	string (Endpoint) Default: ""
auth_type	string (ProviderAuthType) Default: "none" Enum: "none" "passthrough" "api_key" Represents the different types of auth we support for providers.

Responses

http://localhost:8989/api/v1/provider-endpoints/{provider_name}

Request samples

• Payload

Content type

application/json

{

• "id": "",
• "name": "string",
• "description": "",
• "provider_type": "openai",
• "endpoint": "",
• "auth_type": "none"

}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "",
• "name": "string",
• "description": "",
• "provider_type": "openai",
• "endpoint": "",
• "auth_type": "none"

}

Delete Provider Endpoint

Delete a provider endpoint by name.

path Parameters

provider_name required

string (Provider Name)

Responses

http://localhost:8989/api/v1/provider-endpoints/{provider_name}

Response samples

• 200
• 422

Content type

application/json

null

Configure Auth Material

Configure auth material for a provider.

path Parameters

provider_name required

string (Provider Name)

Request Body schema: application/json

required

auth_type required	string (ProviderAuthType) Enum: "none" "passthrough" "api_key" Represents the different types of auth we support for providers.
	Api Key (string) or Api Key (null) (Api Key)

Responses

http://localhost:8989/api/v1/provider-endpoints/{provider_name}/auth-material

Request samples

• Payload

Content type

application/json

{

• "auth_type": "none",
• "api_key": "string"

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Workspaces

List Workspaces

List all workspaces.

Args: provider_name (Optional[str]): Filter workspaces by provider name. If provided, will return workspaces where models from the specified provider (e.g., OpenAI, Anthropic) have been used in workspace muxing rules.

Returns: ListWorkspacesResponse: A response object containing the list of workspaces.

query Parameters

Provider Name (string) or Provider Name (null) (Provider Name)

Responses

http://localhost:8989/api/v1/workspaces

Response samples

• 200
• 422

Content type

application/json

{

• "workspaces": [

  • {

    • "name": "string",
    • "is_active": true

    }

  ]

}

Create Workspace

Create a new workspace.

Request Body schema: application/json

required

name required	string (Name)
	WorkspaceConfig (object) or null

Responses

http://localhost:8989/api/v1/workspaces

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "config": {

  • "custom_instructions": "string",
  • "muxing_rules": [

    • {

      • "provider_name": "string",
      • "provider_type": "openai",
      • "model": "string",
      • "matcher_type": "catch_all",
      • "matcher": "string"

      }

    ]

  }

}

Response samples

• 201
• 422

Content type

application/json

{

• "name": "string",
• "config": {

  • "custom_instructions": "string",
  • "muxing_rules": [

    • {

      • "provider_name": "string",
      • "provider_type": "openai",
      • "model": "string",
      • "matcher_type": "catch_all",
      • "matcher": "string"

      }

    ]

  }

}

List Active Workspaces

List all active workspaces.

In it's current form, this function will only return one workspace. That is, the globally active workspace.

Responses

http://localhost:8989/api/v1/workspaces/active

Response samples

• 200

Content type

application/json

{

• "workspaces": [

  • {

    • "name": "string",
    • "is_active": true,
    • "last_updated": null

    }

  ]

}

Activate Workspace

Activate a workspace by name.

query Parameters

status_code

any (Status Code) Default: 204

Request Body schema: application/json

required

name required

string (Name)

Responses

http://localhost:8989/api/v1/workspaces/active

Request samples

• Payload

Content type

application/json

{

• "name": "string"

}

Response samples

• 200
• 422

Content type

application/json

null

Update Workspace

Update a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Request Body schema: application/json

required

name required	string (Name)
	WorkspaceConfig (object) or null

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "config": {

  • "custom_instructions": "string",
  • "muxing_rules": [

    • {

      • "provider_name": "string",
      • "provider_type": "openai",
      • "model": "string",
      • "matcher_type": "catch_all",
      • "matcher": "string"

      }

    ]

  }

}

Response samples

• 200
• 422

Content type

application/json

{

• "name": "string",
• "config": {

  • "custom_instructions": "string",
  • "muxing_rules": [

    • {

      • "provider_name": "string",
      • "provider_type": "openai",
      • "model": "string",
      • "matcher_type": "catch_all",
      • "matcher": "string"

      }

    ]

  }

}

Delete Workspace

Delete a workspace by name.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}

Response samples

• 200
• 422

Content type

application/json

null

Get Workspace By Name

List workspaces by provider ID.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}

Response samples

• 200
• 422

Content type

application/json

{

• "name": "string",
• "config": {

  • "custom_instructions": "string",
  • "muxing_rules": [

    • {

      • "provider_name": "string",
      • "provider_type": "openai",
      • "model": "string",
      • "matcher_type": "catch_all",
      • "matcher": "string"

      }

    ]

  }

}

List Archived Workspaces

List all archived workspaces.

Responses

http://localhost:8989/api/v1/workspaces/archive

Response samples

• 200

Content type

application/json

{

• "workspaces": [

  • {

    • "name": "string",
    • "is_active": true

    }

  ]

}

Recover Workspace

Recover an archived workspace by name.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/archive/{workspace_name}/recover

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Hard Delete Workspace

Hard delete an archived workspace by name.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/archive/{workspace_name}

Response samples

• 200
• 422

Content type

application/json

null

Get Workspace Alerts

Get alerts for a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/alerts

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "conversation": {

    • "question_answers": [

      • {

        • "question": {

          • "message": "string",
          • "timestamp": "2019-08-24T14:15:22Z",
          • "message_id": "string"

          },
        • "answer": {

          • "message": "string",
          • "timestamp": "2019-08-24T14:15:22Z",
          • "message_id": "string"

          }

        }

      ],
    • "provider": "string",
    • "type": "chat",
    • "chat_id": "string",
    • "conversation_timestamp": "2019-08-24T14:15:22Z",
    • "token_usage_agg": {

      • "tokens_by_model": {

        • "property1": {

          • "provider_type": "openai",
          • "model": "string",
          • "token_usage": {

            • "input_tokens": 0,
            • "output_tokens": 0,
            • "input_cost": 0,
            • "output_cost": 0

            }

          },
        • "property2": {

          • "provider_type": "openai",
          • "model": "string",
          • "token_usage": {

            • "input_tokens": 0,
            • "output_tokens": 0,
            • "input_cost": 0,
            • "output_cost": 0

            }

          }

        },
      • "token_usage": {

        • "input_tokens": 0,
        • "output_tokens": 0,
        • "input_cost": 0,
        • "output_cost": 0

        }

      },
    • "alerts": [ ]

    },
  • "alert_id": "string",
  • "code_snippet": {

    • "code": "string",
    • "language": "string",
    • "filepath": "string",
    • "libraries": [ ],
    • "file_extension": "string"

    },
  • "trigger_string": "string",
  • "trigger_type": "string",
  • "trigger_category": "string",
  • "timestamp": "2019-08-24T14:15:22Z"

  }

]

Get Workspace Alerts Summary

Get alert summary for a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/alerts-summary

Response samples

• 200
• 422

Content type

application/json

{

• "malicious_packages": 0,
• "pii": 0,
• "secrets": 0,
• "total_alerts": 0

}

Get Workspace Messages

Get messages for a workspace.

path Parameters

workspace_name required

string (Workspace Name)

query Parameters

page	integer (Page) >= 1 Default: 1
page_size	integer (Page Size) [ 1 .. 100 ] Default: 50
	Array of Filter By Ids (strings) or Filter By Ids (null) (Filter By Ids)
	Array of Filter By Alert Trigger Types (strings) or Filter By Alert Trigger Types (null) (Filter By Alert Trigger Types)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/messages

Response samples

• 200
• 422

Content type

application/json

{

• "data": [

  • {

    • "chat_id": "string",
    • "prompt": {

      • "message": "string",
      • "timestamp": "2019-08-24T14:15:22Z",
      • "message_id": "string"

      },
    • "alerts_summary": {

      • "malicious_packages": 0,
      • "pii": 0,
      • "secrets": 0,
      • "total_alerts": 0

      },
    • "token_usage_agg": {

      • "tokens_by_model": {

        • "property1": {

          • "provider_type": "openai",
          • "model": "string",
          • "token_usage": {

            • "input_tokens": 0,
            • "output_tokens": 0,
            • "input_cost": 0,
            • "output_cost": 0

            }

          },
        • "property2": {

          • "provider_type": "openai",
          • "model": "string",
          • "token_usage": {

            • "input_tokens": 0,
            • "output_tokens": 0,
            • "input_cost": 0,
            • "output_cost": 0

            }

          }

        },
      • "token_usage": {

        • "input_tokens": 0,
        • "output_tokens": 0,
        • "input_cost": 0,
        • "output_cost": 0

        }

      },
    • "provider": "string",
    • "type": "chat",
    • "conversation_timestamp": "2019-08-24T14:15:22Z"

    }

  ],
• "limit": 0,
• "offset": 0,
• "total": 0

}

Get Messages By Prompt Id

Get messages for a workspace.

path Parameters

workspace_name required	string (Workspace Name)
prompt_id required	string (Prompt Id)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/messages/{prompt_id}

Response samples

• 200
• 422

Content type

application/json

{

• "question_answers": [

  • {

    • "question": {

      • "message": "string",
      • "timestamp": "2019-08-24T14:15:22Z",
      • "message_id": "string"

      },
    • "answer": {

      • "message": "string",
      • "timestamp": "2019-08-24T14:15:22Z",
      • "message_id": "string"

      }

    }

  ],
• "provider": "string",
• "type": "chat",
• "chat_id": "string",
• "conversation_timestamp": "2019-08-24T14:15:22Z",
• "token_usage_agg": {

  • "tokens_by_model": {

    • "property1": {

      • "provider_type": "openai",
      • "model": "string",
      • "token_usage": {

        • "input_tokens": 0,
        • "output_tokens": 0,
        • "input_cost": 0,
        • "output_cost": 0

        }

      },
    • "property2": {

      • "provider_type": "openai",
      • "model": "string",
      • "token_usage": {

        • "input_tokens": 0,
        • "output_tokens": 0,
        • "input_cost": 0,
        • "output_cost": 0

        }

      }

    },
  • "token_usage": {

    • "input_tokens": 0,
    • "output_tokens": 0,
    • "input_cost": 0,
    • "output_cost": 0

    }

  },
• "alerts": [ ]

}

Get Workspace Custom Instructions

Get the custom instructions of a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/custom-instructions

Response samples

• 200
• 422

Content type

application/json

{

• "prompt": "string"

}

Set Workspace Custom Instructions

path Parameters

workspace_name required

string (Workspace Name)

Request Body schema: application/json

required

prompt required

string (Prompt)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/custom-instructions

Request samples

• Payload

Content type

application/json

{

• "prompt": "string"

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Delete Workspace Custom Instructions

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/custom-instructions

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Get Workspace Muxes

Get the mux rules of a workspace.

The list is ordered in order of priority. That is, the first rule in the list has the highest priority.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/muxes

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "provider_name": "string",
  • "provider_type": "openai",
  • "model": "string",
  • "matcher_type": "catch_all",
  • "matcher": "string"

  }

]

Set Workspace Muxes

Set the mux rules of a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Request Body schema: application/json

required

Array

provider_name required	string (Provider Name)
provider_type required	string (ProviderType) Enum: "openai" "anthropic" "vllm" "ollama" "lm_studio" "llamacpp" "openrouter" Represents the different types of providers we support.
model required	string (Model)
matcher_type required	string (MuxMatcherType) Enum: "catch_all" "filename_match" "fim_filename" "chat_filename" Represents the different types of matchers we support. The 3 rules present match filenames and request types. They're used in conjunction with the matcher field in the MuxRule model. E.g. catch_all-> Always match filename_match and match: requests.py -> Match the request if the filename is requests.py fim_filename and match: main.py -> Match the request if the request type is fim and the filename is main.py NOTE: Removing or updating fields from this enum will require a migration. Adding new fields is safe.
	Matcher (string) or Matcher (null) (Matcher)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/muxes

Request samples

• Payload

Content type

application/json

[

• {

  • "provider_name": "string",
  • "provider_type": "openai",
  • "model": "string",
  • "matcher_type": "catch_all",
  • "matcher": "string"

  }

]

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Get Workspace Token Usage

Get the token usage of a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/token-usage

Response samples

• 200
• 422

Content type

application/json

{

• "tokens_by_model": {

  • "property1": {

    • "provider_type": "openai",
    • "model": "string",
    • "token_usage": {

      • "input_tokens": 0,
      • "output_tokens": 0,
      • "input_cost": 0,
      • "output_cost": 0

      }

    },
  • "property2": {

    • "provider_type": "openai",
    • "model": "string",
    • "token_usage": {

      • "input_tokens": 0,
      • "output_tokens": 0,
      • "input_cost": 0,
      • "output_cost": 0

      }

    }

  },
• "token_usage": {

  • "input_tokens": 0,
  • "output_tokens": 0,
  • "input_cost": 0,
  • "output_cost": 0

  }

}

Muxes

Get Workspace Muxes

Get the mux rules of a workspace.

The list is ordered in order of priority. That is, the first rule in the list has the highest priority.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/muxes

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "provider_name": "string",
  • "provider_type": "openai",
  • "model": "string",
  • "matcher_type": "catch_all",
  • "matcher": "string"

  }

]

Set Workspace Muxes

Set the mux rules of a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Request Body schema: application/json

required

Array

provider_name required	string (Provider Name)
provider_type required	string (ProviderType) Enum: "openai" "anthropic" "vllm" "ollama" "lm_studio" "llamacpp" "openrouter" Represents the different types of providers we support.
model required	string (Model)
matcher_type required	string (MuxMatcherType) Enum: "catch_all" "filename_match" "fim_filename" "chat_filename" Represents the different types of matchers we support. The 3 rules present match filenames and request types. They're used in conjunction with the matcher field in the MuxRule model. E.g. catch_all-> Always match filename_match and match: requests.py -> Match the request if the filename is requests.py fim_filename and match: main.py -> Match the request if the request type is fim and the filename is main.py NOTE: Removing or updating fields from this enum will require a migration. Adding new fields is safe.
	Matcher (string) or Matcher (null) (Matcher)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/muxes

Request samples

• Payload

Content type

application/json

[

• {

  • "provider_name": "string",
  • "provider_type": "openai",
  • "model": "string",
  • "matcher_type": "catch_all",
  • "matcher": "string"

  }

]

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Dashboard

Stream Sse

Send alerts event

Responses

http://localhost:8989/api/v1/alerts_notification

Response samples

• 200

Content type

application/json

null

Version Check

Responses

http://localhost:8989/api/v1/version

Response samples

• 200

Content type

application/json

null

Token Usage

Get Workspace Token Usage

Get the token usage of a workspace.

path Parameters

workspace_name required

string (Workspace Name)

Responses

http://localhost:8989/api/v1/workspaces/{workspace_name}/token-usage

Response samples

• 200
• 422

Content type

application/json

{

• "tokens_by_model": {

  • "property1": {

    • "provider_type": "openai",
    • "model": "string",
    • "token_usage": {

      • "input_tokens": 0,
      • "output_tokens": 0,
      • "input_cost": 0,
      • "output_cost": 0

      }

    },
  • "property2": {

    • "provider_type": "openai",
    • "model": "string",
    • "token_usage": {

      • "input_tokens": 0,
      • "output_tokens": 0,
      • "input_cost": 0,
      • "output_cost": 0

      }

    }

  },
• "token_usage": {

  • "input_tokens": 0,
  • "output_tokens": 0,
  • "input_cost": 0,
  • "output_cost": 0

  }

}

Personas

List Personas

List all personas.

Responses

http://localhost:8989/api/v1/personas

Response samples

• 200

Content type

application/json

[

• {

  • "id": "string",
  • "name": "string",
  • "description": "string"

  }

]

Create Persona

Create a new persona.

Request Body schema: application/json

required

name required	string (Name)
description required	string (Description)

Responses

http://localhost:8989/api/v1/personas

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "description": "string"

}

Response samples

• 201
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string"

}

Get Persona

Get a persona by name.

path Parameters

persona_name required

string (Persona Name)

Responses

http://localhost:8989/api/v1/personas/{persona_name}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string"

}

Update Persona

Update an existing persona.

path Parameters

persona_name required

string (Persona Name)

Request Body schema: application/json

required

new_name required	string (New Name)
new_description required	string (New Description)

Responses

http://localhost:8989/api/v1/personas/{persona_name}

Request samples

• Payload

Content type

application/json

{

• "new_name": "string",
• "new_description": "string"

}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string"

}

Delete Persona

Delete a persona.

path Parameters

persona_name required

string (Persona Name)

Responses

http://localhost:8989/api/v1/personas/{persona_name}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}