Update a source

PATCH

/api/v1/sources/{id}

The file itself cannot be replaced; upload a new source instead.

Authorizations

bearerAuth

Path Parameters

NameType

required

string

The record’s prefixed ID

Request Body^required

application/json

object

source

required

object

title

string

description

string

Responses

200

The updated source

Response body

application/json

object

string

title

string

description

string | null

state

string

Allowed values: new ocr_job_started ocr_job_completed ocr_job_failed ocr_data_processed embedding_complete embedding_failed

Processing state. Passages are searchable once embedding_complete.

file

object

filename

string

content_type

string

byte_size

integer

download_url

string | null format: uri

The download endpoint for this source

created_at

string format: date-time

updated_at

string format: date-time

403

Insufficient scope, role, or credits

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

404

No such record in this account

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

422

The record could not be saved

Response body

application/json

object

error

object

code

string

A stable machine-readable code

message

string

details

Array<string>

Present on validation errors; one entry per failed validation

Request

curl --request PATCH \
  --url https://app.responsehub.io/api/v1/sources/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "source": { "title": "example", "description": "example" } }'

require 'uri'
require 'net/http'

url = URI("https://app.responsehub.io/api/v1/sources/example")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{ \"source\": { \"title\": \"example\", \"description\": \"example\" } }"

response = http.request(request)
puts response.read_body

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://app.responsehub.io/api/v1/sources/example', [
  'body' => '{ "source": { "title": "example", "description": "example" } }',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

const url = 'https://app.responsehub.io/api/v1/sources/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"source":{"title":"example","description":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://app.responsehub.io/api/v1/sources/example"

  payload := strings.NewReader("{ \"source\": { \"title\": \"example\", \"description\": \"example\" } }")

  req, _ := http.NewRequest("PATCH", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

Request body example

Example^generated

{
  "source": {
    "title": "example",
    "description": "example"
  }
}

200example

Example^generated

{
  "id": "s_1a2b",
  "title": "example",
  "description": "example",
  "state": "new",
  "file": {
    "filename": "security-policy.pdf",
    "content_type": "application/pdf",
    "byte_size": 1
  },
  "download_url": "https://example.com",
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z"
}

403example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

404example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

422example

Example^generated

{
  "error": {
    "code": "not_found",
    "message": "example",
    "details": [
      "example"
    ]
  }
}

Update a source

Authorizations

Path Parameters

Request Bodyrequired

Responses

200

403

404

422

Request Body^required