Documentation
  • 👋Welcome to Documentation
  • 📖Glossary
  • ❓FAQs
  • General
    • Getting set up
      • Single-user organization
      • Multi-user organization
    • Supported Document Types
  • Platform Walkthrough
    • Dashboard
    • Queue
    • Configuration
    • Supervision
  • User guide How Tos
    • User Management
      • How to invite a new user to the platform?
      • How can I manage existing users?
    • Processes
      • How to create a supervised process or use the template?
      • How to create a custom process?
    • Supervision
      • How to add, assign, and remove annotations?
      • How to edit the value of the extraction?
      • How to open and edit a table mask?
      • How to open, edit, or remove the extracted table?
      • How to export your data via Supervision?
      • How to copy values and tables?
    • Upload
    • Converters
    • Data points definition
    • Data Export
    • Table Data Extraction
    • Enrichment
    • Generating new API key
  • Integrations
    • Zapier Integration
      • Quickstart
      • Alphamoon as a Trigger
      • Alphamoon as an Action
    • Google Sheets - Export
  • Features
    • Continuous Learning (Beta)
    • Document Splitting
  • API
    • Introduction
    • Quickstart
    • Organization API keys (Beta)
    • Process API keys (Beta)
    • Authenticating
    • Versioning
    • Get results
    • Get OCR results
    • Get processes
    • Get process types
    • Get collections
    • Metadata
      • Setting metadata value
    • Upload File
    • Export
    • Download original files
    • Delete collection
    • Reset process configuration
  • Resources
    • 💻Alphamoon Website
Powered by GitBook
On this page
  1. API

Reset process configuration

A quick guide on how to reset process configuration to default by ID, using the Alphamoon API

PreviousDelete collection

Last updated 11 months ago

To reset process configuration via API, a user needs to get the process_id from one of the following sources:

  • endpoint

  • Create process endpoint

  • URL e.g. https://workspace.alphamoon.ai/queue/2080d36bf94c4147b2e543104342fc2f

Use the following endpoint to reset the process configuration to default:

Reset process configuration to default by ID

POST /api/v0.3/processes/{process_id}/config/reset

Path parameters

Name
Type
Description

process-id*

String

The ID of the process


  "id": "2080d36bf94c4147b2e543104342fc2f",
  "name": "Custom",
  "typeId": "29b0618e37a94dc9950e7fcfaff338b9",
  "typeName": "Custom",
  "status": "Ready",
  "version": "0.1",
  "usage": null,
  "configId": "5768f90afb99469eb8c9c55aeb8ba19f",
  "orgId": "USER:google-oauth2|106671234597104793600",
  "createdBy": "google-oauth2|106671234597104793600",
  "createdAt": "2023-07-11T14:18:51Z",
  "updatedAt": "2024-04-02T14:24:25Z",
  "lastUpdated": "2024-04-02T14:24:25Z",
  "accesses": {}
}
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

See the example:

curl -X 'POST' \
  'https://workspace.alphamoon.ai/api/v0.3/processes/2080d36bf94c4147b2e543104342fc2f/config/reset' \
  -H 'accept: application/json' \
  -H 'Authorization: Basic API_KEY_BASE64_ENCODED'
{
  "id": "2080d36bf94c4147b2e543104342fc2f",
  "name": "Custom",
  "typeId": "29b0618e37a94dc9950e7fcfaff338b9",
  "typeName": "Custom",
  "status": "Ready",
  "version": "0.1",
  "usage": null,
  "configId": "5768f90afb99469eb8c9c55aeb8ba19f",
  "orgId": "USER:google-oauth2|106671234597104793600",
  "createdBy": "google-oauth2|106671234597104793600",
  "createdAt": "2023-07-11T14:18:51Z",
  "updatedAt": "2024-04-02T14:24:25Z",
  "lastUpdated": "2024-04-02T14:24:25Z",
  "accesses": {}
}

See next:

Get process
es