NimroboNIMROBOBack to website
Login
API Reference

Voice Projects

Endpoints for managing voice projects and project-based voice links.

Projects

Create, list, read, and update voice projects owned by the authenticated user.

Endpoints
  • GET /v1/projects — list all projects (scope: projects:read)
  • POST /v1/projects — create a new project (scope: projects:write)
  • GET /v1/projects/{projectId} — get one project (scope: projects:read)
  • PATCH /v1/projects/{projectId} — update a project (scope: projects:write)

Create project body (POST /v1/projects)

  • name: string (required)
  • prompt: string (required)
  • description: string (optional; defaults to "")
  • landingPageTitle: string (optional; defaults to "")
  • landingPageInfo: string (optional; defaults to "")
  • timeLimitMinutes: number (optional; defaults to 5)
  • evaluator: object (optional)
    • prompt: string (required if evaluator provided)
    • questions: array (required if evaluator provided)
    • each question: { id: string, label: string, type: "text" | "number" }

Update project body (PATCH /v1/projects/{projectId})

Same shape as creation, but supports setting evaluator to null to remove it.

  • name: string (required)
  • prompt: string (required)
  • Optional fields: description, landingPageTitle, landingPageInfo, timeLimitMinutes, evaluator (object | null)