TODO for AI Logo
TODOforAI API

Schemas

LoginRequest

  • emailstring · email · required
    Example: user@example.com
  • passwordstring · password · required
    Example: password123
  • fingerprintstring · required
    Example: device-fingerprint-123

ChangePasswordRequest

  • currentPasswordstring · password · required
    Example: oldPassword123
  • newPasswordstring · password · required
    Example: newPassword456

CreateApiKeyRequest

  • namestring · required
    Example: My API Key

ApiKeyResponse

  • namestring
    Example: My API Key
  • idstring
    Example: apikey-123
  • createdAtinteger · int64
    Example: 1625097600000
  • isDefaultboolean
    Example: true

RegisterRequest

  • emailstring · email · required
    Example: user@example.com
  • passwordstring · password · required
    Example: password123
  • fingerprintstring · required
    Example: device-fingerprint-123
  • tempUserIdstring
    Example: temp-user-123

TempLoginRequest

  • fingerprintstring · required
    Example: device-fingerprint-123

AuthResponse

  • userobject
  • settingsobject
  • tokenstring
    Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

UserProfile

  • idstring
    Example: user-123
  • emailstring · email
    Example: user@example.com
  • isTemporaryboolean
    Example: false
  • lastProjectIdstring
    Example: project-123
  • createdAtinteger · int64
    Example: 1625097600000
  • balancenumber · float
    Example: 100.5
  • freeTrialTodosLeftinteger
    Example: 5
  • todoIdToAgentIdobject
    Example: {"todo-123":"agent-456"}

UserProfileResponse

  • userobject
  • settingsobject

UserSettings

  • idstring
    Example: settings-123
  • userIdstring
    Example: user-123
  • fullNamestring
    Example: John Doe
  • profilePicturestring
    Example: https://example.com/profile.jpg
  • themestring
    Example: dark
  • diffControlstring
    Example: unified
  • shellExecutionstring
    Example: auto
  • emailNotificationsboolean
    Example: true
  • pushNotificationsboolean
    Example: true
  • dataAnalyticsboolean
    Example: true
  • autoSaveboolean
    Example: true
  • confirmBeforeDeleteboolean
    Example: true
  • playSoundOnTaskCompleteboolean
    Example: true
  • keyboardBindingsobject
    Example: {"save":"ctrl+s"}
  • keyboardShortcutsEnabledboolean
    Example: true

ProjectCreateBody

  • namestring · required
    Example: My Project
  • isPublicboolean · required
    Example: false
  • descriptionstring
    Example: A description of my project

ProjectUpdateBody

  • namestring
    Example: Updated Project Name
  • descriptionstring
    Example: Updated project description
  • isPublicboolean
    Example: true
  • statusstring · enum
    Enum values:
    ACTIVE
    ARCHIVED
    DELETED
    Example: ACTIVE

ProjectResponse

  • idstring
    Example: project-123
  • namestring
    Example: My Project
  • descriptionstring
    Example: A description of my project
  • ownerIdstring
    Example: user-123
  • ownerEmailstring · email
    Example: owner@example.com
  • isPublicboolean
    Example: false
  • readAccessIdsstring[]
    Example: ["user-456","user-789"]
  • writeAccessIdsstring[]
    Example: ["user-456"]
  • readAccessEmailsstring[]
    Example: ["reader@example.com"]
  • writeAccessEmailsstring[]
    Example: ["writer@example.com"]
  • contextstring
    Example: Project context information
  • statusstring · enum
    Enum values:
    ACTIVE
    ARCHIVED
    DELETED
    Example: ACTIVE
  • isDefaultboolean
    Example: false
  • createdAtinteger · int64
    Example: 1625097600000
  • updatedAtinteger · int64
    Example: 1625097600000

ProjectSettings

  • idstring
    Example: settings-123
  • projectIdstring
    Example: project-123

ProjectResponseWithSettings

  • projectobject
  • settingsobject

ProjectPublicityBody

  • isPublicboolean · required
    Example: true

ProjectOwnershipBody

  • newOwnerIdstring · required
    Example: user-456

ShareProjectRequest

  • emailstring · email · required
    Example: collaborator@example.com
  • canWriteboolean · required
    Example: true

TodoChunkResponse

  • idstring
    Example: todo-123
  • projectIdstring
    Example: project-123
  • statusstring · enum
    Enum values:
    LISTENING
    THINKING
    DONE
    FAILED
    CANCELLED
    SCHEDULED
    Example: LISTENING
  • contentstring
    Example: Task description
  • createdAtinteger · int64
    Example: 1625097600000
  • lastActivityAtinteger · int64
    Example: 1625097600000
  • scheduledTimestampinteger · int64
    Example: 1625097600000

TodoResponse

  • idstring
    Example: todo-123
  • projectIdstring
    Example: project-123
  • statusstring · enum
    Enum values:
    LISTENING
    THINKING
    DONE
    FAILED
    CANCELLED
    SCHEDULED
    Example: LISTENING
  • contentstring
    Example: TODO description
  • messagesobject[]
  • createdAtinteger · int64
    Example: 1625097600000
  • lastActivityAtinteger · int64
    Example: 1625097600000
  • scheduledTimestampinteger · int64
    Example: 1625097600000

MessageResponse

  • idstring
    Example: message-123
  • contentstring
    Example: Message content
  • rolestring
    Example: user
  • createdAtinteger · int64
    Example: 1625097600000
  • blockTypesstring[]
    Example: ["TEXT","CODE"]
  • blocksstring
    Example: serialized-blocks
  • itokinteger
    Example: 100
  • otokinteger
    Example: 500
  • cache_writeinteger
    Example: 10
  • cache_readinteger
    Example: 5
  • pricenumber · float
    Example: 0.05
  • elapsedinteger
    Example: 2500
  • scheduledTimestampinteger · int64
    Example: 1625097600000
  • attachmentsobject[]
  • attachmentsPricenumber · float
    Example: 0.01
  • attachmentsElapsedinteger
    Example: 500

FileAttachment

  • idstring · required
    Example: attachment-123
  • sourcestring · required
    Example: upload
  • typestring · required
    Example: application/pdf
  • statusstring · enum · required
    Enum values:
    NEW
    UPDATED
    DELETED
    NONE
    Example: NEW
  • sizeinteger
    Example: 1024
  • contentstring
    Example: text content

TodoContentBody

  • todoIdstring · required
    Example: todo-123
  • projectIdstring · required
    Example: project-123
  • contentstring · required
    Example: TODO content
  • rolestring · required
    Example: user
  • agentSettingsIdstring · required
    Example: agent-123
  • attachmentsobject[] · required
  • scheduledTimestampinteger · int64
    Example: 1625097600000

TodoStatusBody

  • statusstring · enum · required
    Enum values:
    LISTENING
    THINKING
    DONE
    FAILED
    CANCELLED
    SCHEDULED
    Example: DONE

TodoUpdateContent

  • statusstring · enum · required
    Enum values:
    LISTENING
    THINKING
    DONE
    FAILED
    CANCELLED
    SCHEDULED
    Example: LISTENING
  • agentSettingsIdstring · required
    Example: agent-123

TodoStartImmediately

  • messageIdstring · required
    Example: message-123
  • agentSettingsIdstring · required
    Example: agent-123

TodoUpdateStartImmediately

  • messageIdstring · required
    Example: message-123
  • agentSettingsIdstring · required
    Example: agent-123
  • attachmentsobject[]
  • contentstring
    Example: Updated content

TodoUpdateScheduledDate

  • scheduledTimestampinteger · int64 · required
    Example: 1625097600000
  • messageIdstring · required
    Example: message-123
  • agentSettingsIdstring · required
    Example: agent-123

MessageAppendBody

  • contentstring · required
    Example: Additional content
  • attachmentsobject[]

MessageUpdateBody

  • contentstring
    Example: Updated content
  • attachmentsobject[]
  • scheduledTimestampinteger · int64
    Example: 1625097600000

AgentSettingsResponse

  • 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

AgentSettingsUpdate

  • 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

AgentEdgeRequest

  • edgeIdstring · required
    Example: edge-123

MCPConfig

  • isActiveboolean · required
    Example: true
Additional properties are allowed

ConfMCP

  • isActiveboolean · required
    Example: true
Additional properties are allowed

MCPToolSkeleton

  • namestring · required
    Example: sendEmail
  • descriptionstring · required
    Example: Sends an email to the specified recipient

MCPClientSkeleton

  • serverIdstring · required
    Example: mcp-server-123
  • toolsobject[] · required
  • envstring[] · required
    Example: ["API_KEY","SECRET_TOKEN"]

MCPResponse

  • idstring
    Example: mcp-123
  • agentIdstring
    Example: agent-123
  • mcpsobject
  • updatedAtinteger · int64
    Example: 1625097600000

DataSourceBody

  • namestring · required
    Example: My Data Source
  • contentstring · required
    Example: Data source content

DataSourceResponse

  • idstring
    Example: datasource-123
  • namestring
    Example: My Data Source
  • contentstring

SuccessType

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

ProjectSettingsResponse

  • idstring
    Example: settings-123
  • projectIdstring
    Example: project-123

UserBalanceResponse

  • balancenumber · float
    Example: 100.5
  • currencystring
    Example: USD

PaginatedTransactionsResponse

  • transactionsobject[]
  • totalCountinteger
    Example: 50
  • pageinteger
    Example: 1
  • limitinteger
    Example: 10

InvoiceResponse

  • idstring
    Example: invoice-123
  • amountnumber · float
    Example: 59.99
  • statusstring
    Example: paid
  • createdAtinteger · int64
    Example: 1625097600000
  • paidAtinteger · int64
    Example: 1625184000000

EdgeResponse

  • idstring
    Example: edge-123
  • namestring
    Example: My Edge
  • typestring
    Example: shell
  • statusstring
    Example: active
  • createdAtinteger · int64
    Example: 1625097600000

EdgeUpdateBody

  • namestring
    Example: Updated Edge Name

UserDataSourceResponse

  • idstring
    Example: datasource-123
  • namestring
    Example: My Data Source
  • ownerIdstring
    Example: user-123
  • createdAtinteger · int64
    Example: 1625097600000

ProjectDataSourceResponse

  • idstring
    Example: datasource-123
  • namestring
    Example: My Data Source
  • projectIdstring
    Example: project-123
  • createdAtinteger · int64
    Example: 1625097600000