AFaffinda
Workspaces

Create a workspace

Changed on

Create a workspace

post/v3/workspaces

Request

Request body

organizationstring required

Uniquely identify an organization.

namestring required
visibility'organization' | 'private'

Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the workspace.

rejectInvalidDocumentsboolean

If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed.

rejectDuplicatesboolean nullable

If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.

documentTypesPropertiesIdentifier[]

Document types to associate with this workspace

whitelistIngestAddressesstring[] nullable

If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. "*@eyefind.info".

documentSplitterstring

Uniquely identify a document splitter.

Example request

{
  "organization": "mEFayXdO",
  "visibility": "organization",
  "rejectDuplicates": true,
  "documentTypes": [
    "mEFayXdO"
  ],
  "whitelistIngestAddresses": [
    "*@eyefind.info"
  ],
  "documentSplitter": "NqIvMvZl"
}

Response

Successfully created a workspace.

identifierstring required

Uniquely identify a workspace.

namestring
visibility'organization' | 'private'

Visibility "organization" means everyone in the organization can access the workspace. Visibility "private" means only people explicitly added can access the workspace.

documentTypesPropertiesIdentifier[]

Document types associated with this workspace

rejectInvalidDocumentsboolean

If true, the uploaded document will be rejected if it's of the wrong document type, or if its document type cannot be determined. No credits will be consumed.

rejectDuplicatesboolean nullable

If "true", parsing will fail when the uploaded document is duplicate of an existing document, no credits will be consumed. If "false", will parse the document normally whether its a duplicate or not. If not provided, will fallback to the workspace settings.

unvalidatedDocsCountinteger

Number of unvalidated documents in the workspace.

confirmedDocsCountinteger

Number of validated documents in the workspace.

ingestEmailstring

When you send email to this address, any document attached in the body will be uploaded to this workspace.

whitelistIngestAddressesstring[] nullable

If specified, only emails from these addresses will be ingested for parsing. Wild cards are allowed, e.g. "*@eyefind.info".

Example response

{
  "identifier": "mEFayXdO",
  "organization": {
    "identifier": "mEFayXdO",
    "name": "Grove Street King",
    "userRole": "admin",
    "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
    "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad"
  },
  "visibility": "organization",
  "collections": [
    {
      "identifier": "mEFayXdO",
      "extractor": {
        "identifier": "resume",
        "baseExtractor": {
          "identifier": "resume"
        },
        "category": "Recruitment"
      }
    }
  ],
  "documentTypes": [
    "mEFayXdO"
  ],
  "rejectDuplicates": true,
  "members": [
    {
      "id": 1,
      "name": "Carl Johnson",
      "username": "carljohnson",
      "email": "carljohnson@grove.street",
      "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
    }
  ],
  "whitelistIngestAddresses": [
    "*@eyefind.info"
  ],
  "documentSplitter": {
    "identifier": "NqIvMvZl"
  }
}

Changes

  • acca5642c0bcRevision changes
    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      added the required property / to the response with the status

  • 978cf99a2ac0Revision changes
    • warning

      removed the optional property /// from the response with the status

    • info

      api tag Workspaces added

    • info

      api tag Document API - Workspace removed

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status