TODO for AI Logo
TODOforAI API

Agent Settings

Endpoint:/api/v1

Agent settings operations

List agent settings

GET
/api/v1
/Agent Settings

Returns a list of agent settings for the authenticated user

List agent settings › Responses

Successful operation

  • idstring
    Example: agent-123
  • namestring
    Example: My Agent
  • ownerIdstring
    Example: user-123
  • createdAtinteger · int64
    Example: 1625097600000
  • systemMessagestring
    Example: System message for the agent
  • maxTokensinteger
    Example: 2048
  • shellEdgeIdstring
    Example: edge-123
  • workspaceEdgeIdstring
    Example: edge-456
  • selectedWorkspacepathsstring[]
    Example: ["/path/to/workspace"]
  • skillsstring
    Example: shell,files,modify
  • mcpsConfigobject
    Example: {"gmail":{"isActive":true,"additionalSetting":"value"}}
  • modelstring
    Example: gpt-4
  • plannerModelstring
    Example: gpt-3.5-turbo
  • automaticInstantDiffboolean
    Example: true
  • automaticRunShellboolean
    Example: true

Create agent settings

POST
/api/v1
/Agent Settings

Creates new agent settings for the authenticated user

Create agent settings › Request Body

  • namestring
    Example: Updated Agent Name
  • systemMessagestring
    Example: Updated system message
  • maxTokensinteger
    Example: 4096
  • shellEdgeIdstring
    Example: edge-789
  • workspaceEdgeIdstring
    Example: edge-012
  • selectedWorkspacepathsstring[]
    Example: ["/updated/path"]
  • skillsstring
    Example: shell,files,modify,email
  • mcpsConfigobject
    Example: {"gmail":{"isActive":true,"additionalSetting":"value"}}
  • modelstring
    Example: gpt-4-turbo
  • plannerModelstring
    Example: gpt-4
  • automaticInstantDiffboolean
    Example: false
  • automaticRunShellboolean
    Example: false

Create agent settings › Responses

Agent settings created successfully

  • idstring
    Example: agent-123
  • namestring
    Example: My Agent
  • ownerIdstring
    Example: user-123
  • createdAtinteger · int64
    Example: 1625097600000
  • systemMessagestring
    Example: System message for the agent
  • maxTokensinteger
    Example: 2048
  • shellEdgeIdstring
    Example: edge-123
  • workspaceEdgeIdstring
    Example: edge-456
  • selectedWorkspacepathsstring[]
    Example: ["/path/to/workspace"]
  • skillsstring
    Example: shell,files,modify
  • mcpsConfigobject
    Example: {"gmail":{"isActive":true,"additionalSetting":"value"}}
  • modelstring
    Example: gpt-4
  • plannerModelstring
    Example: gpt-3.5-turbo
  • automaticInstantDiffboolean
    Example: true
  • automaticRunShellboolean
    Example: true

Get agent settings by ID

GET
/api/v1
/agents/{agentSettingsId}

Returns agent settings by ID

Get agent settings by ID › path Parameters

  • agentSettingsIdstring · required

    ID of the agent settings

Get agent settings by ID › Responses

Successful operation

  • idstring
    Example: agent-123
  • namestring
    Example: My Agent
  • ownerIdstring
    Example: user-123
  • createdAtinteger · int64
    Example: 1625097600000
  • systemMessagestring
    Example: System message for the agent
  • maxTokensinteger
    Example: 2048
  • shellEdgeIdstring
    Example: edge-123
  • workspaceEdgeIdstring
    Example: edge-456
  • selectedWorkspacepathsstring[]
    Example: ["/path/to/workspace"]
  • skillsstring
    Example: shell,files,modify
  • mcpsConfigobject
    Example: {"gmail":{"isActive":true,"additionalSetting":"value"}}
  • modelstring
    Example: gpt-4
  • plannerModelstring
    Example: gpt-3.5-turbo
  • automaticInstantDiffboolean
    Example: true
  • automaticRunShellboolean
    Example: true

Delete agent settings

DELETE
/api/v1
/agents/{agentSettingsId}

Deletes agent settings by ID

Delete agent settings › path Parameters

  • agentSettingsIdstring · required

    ID of the agent settings

Delete agent settings › Responses

Agent settings deleted successfully

  • successboolean
    Example: true
  • messagestring
    Example: Operation completed successfully

Update edge workspace access

PUT
/api/v1
/agents/{agentSettingsId}/workspace

Updates the workspace edge access for agent settings

Update edge workspace access › path Parameters

  • agentSettingsIdstring · required

    ID of the agent settings

Update edge workspace access › Request Body

  • edgeIdstring · required
    Example: edge-123

Update edge workspace access › Responses

Workspace edge updated successfully

  • successboolean
    Example: true
  • messagestring
    Example: Operation completed successfully

Update shell edge access

PUT
/api/v1
/agents/{agentSettingsId}/shell

Updates the shell edge access for agent settings

Update shell edge access › path Parameters

  • agentSettingsIdstring · required

    ID of the agent settings

Update shell edge access › Request Body

  • edgeIdstring · required
    Example: edge-123

Update shell edge access › Responses

Shell edge updated successfully

  • successboolean
    Example: true
  • messagestring
    Example: Operation completed successfully

Update agent settings

PUT
/api/v1
/agents/{agentSettingsId}/settings

Updates agent settings by ID

Update agent settings › path Parameters

  • agentSettingsIdstring · required

    ID of the agent settings

Update agent settings › Request Body

  • namestring
    Example: Updated Agent Name
  • systemMessagestring
    Example: Updated system message
  • maxTokensinteger
    Example: 4096
  • shellEdgeIdstring
    Example: edge-789
  • workspaceEdgeIdstring
    Example: edge-012
  • selectedWorkspacepathsstring[]
    Example: ["/updated/path"]
  • skillsstring
    Example: shell,files,modify,email
  • mcpsConfigobject
    Example: {"gmail":{"isActive":true,"additionalSetting":"value"}}
  • modelstring
    Example: gpt-4-turbo
  • plannerModelstring
    Example: gpt-4
  • automaticInstantDiffboolean
    Example: false
  • automaticRunShellboolean
    Example: false

Update agent settings › Responses

Agent settings updated successfully

  • idstring
    Example: agent-123
  • namestring
    Example: My Agent
  • ownerIdstring
    Example: user-123
  • createdAtinteger · int64
    Example: 1625097600000
  • systemMessagestring
    Example: System message for the agent
  • maxTokensinteger
    Example: 2048
  • shellEdgeIdstring
    Example: edge-123
  • workspaceEdgeIdstring
    Example: edge-456
  • selectedWorkspacepathsstring[]
    Example: ["/path/to/workspace"]
  • skillsstring
    Example: shell,files,modify
  • mcpsConfigobject
    Example: {"gmail":{"isActive":true,"additionalSetting":"value"}}
  • modelstring
    Example: gpt-4
  • plannerModelstring
    Example: gpt-3.5-turbo
  • automaticInstantDiffboolean
    Example: true
  • automaticRunShellboolean
    Example: true

Update MCP configuration

PUT
/api/v1
/agents/{agentSettingsId}/mcp-config

Updates MCP configuration for agent settings

Update MCP configuration › path Parameters

  • agentSettingsIdstring · required

    ID of the agent settings

Update MCP configuration › Request Body

  • isActiveboolean · required
    Example: true
Additional properties are allowed

Update MCP configuration › Responses

MCP configuration updated successfully

  • successboolean
    Example: true
  • messagestring
    Example: Operation completed successfully
ProjectApi Keys