API Reference

Secure endpoints for Jira-to-IDE orchestration.

The SeeCodes backend, published by eprojac, provides a secure, B2B-focused API for synchronizing task context, progress, and telemetry between your IDE and Jira Cloud.
Regional endpointsTask-scoped permitsEnterprise custom workflows
Read documentationSecurity postureSubmit an issue

Overview

These APIs are primarily for internal use by the SeeCodes Jira App and VS Code Extension. Direct integration is supported for Enterprise customers requiring custom workflows.

Internal-first API surface

The public routes focus on connection bootstrap, task-specific IDE linking, AI task lifecycle management, and progress synchronization back to Jira.

Base URL

All API requests must be sent to your configured regional endpoint.

Example regional endpoint
https://dev.apisview.com/us/v1/

What the API covers

  • Secure connection bootstrap between Jira Cloud and the SeeCodes backend.
  • Permit generation for task-specific IDE access.
  • AI task initialization, execution start, and status polling.
  • Structured progress sync back into Jira.

Authentication

Different surfaces authenticate differently depending on whether the request originates in Jira or inside the IDE.

IDE requests

  • Use a short-lived JSON Web Token (JWT) permit generated by Jira.
  • Permits are created from the authenticated Jira session.
  • Access is scoped to the specific Jira task being opened in the IDE.

Jira App requests

  • Use an Instance API Key.
  • Requests include instance metadata such as cloud ID headers where required.
  • This path is used when the Jira App communicates directly with the SeeCodes backend.

Endpoints

Core endpoints exposed by the SeeCodes backend.
POST/public/connect

Establishes a secure connection between the Jira instance and the SeeCodes backend.

Payload
{
  "cloudId": "string"
}
Response
{
  "ok": true,
  "apiKey": "string",
  "linkSecret": "string"
}
POST/v1/security/vscode-link

Generates a secure, time-bound permit for the IDE to access a specific Jira task.

Headers

  • X-Cloud-Id
  • X-Instance-Key
Payload
{
  "projectId": "string",
  "taskId": "string",
  "userAccountId": "string"
}
Response
{
  "vscodeUrl": "string",
  "httpsUrl": "string",
  "expiresAt": 0
}
POST/v1/tasks/init

Initializes a new AI task run and generates presigned S3 URLs for context upload.

Headers

  • Authorization: Bearer <permit>
Payload
{
  "model": "string",
  "files": ["list.md"]
}
Response
{
  "runId": "string",
  "uploads": {
    "list.md": "https://..."
  }
}
POST/v1/tasks/{runId}/start

Starts the asynchronous AI execution after context has been uploaded.

Headers

  • Authorization: Bearer <permit>
Payload
{
  "model": "string",
  "userPrompt": "string"
}
Response
{
  "status": "queued"
}
GET/v1/tasks/{runId}

Polls the status of an active AI task.

Headers

  • Authorization: Bearer <permit>
Response
{
  "status": {
    "status": "succeeded | failed | processing_remote"
  }
}
POST/v1/tasks/{taskId}/progress

Submits empirical progress data back to the Jira instance.

Headers

  • Authorization: Bearer <permit>
Payload
{
  "ready": ["item 1"],
  "left": ["item 2"],
  "progress": "45%",
  "confidence": "Medium",
  "risks": ["Database change required"]
}

Enterprise workflows

Direct integration is supported for Enterprise customers that need custom workflows beyond the standard Jira App and VS Code Extension flow.

Available lifecycle coverage

The exposed routes cover connection setup, secure IDE task linking, AI run orchestration, task status polling, and structured progress reporting back into Jira.