Cloudharness Dev Portal
CloudCron Schedule Next API

Parse

Endpoint:https://api.cloudharness.com

Parse a raw text address

POST
https://api.cloudharness.com
/v1/parse/address

Parses a raw text address into structured components (leverages AI + public data).

Parse a raw text address › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

  • x-openai-keystring · required

    OpenAI API key for address parsing

Parse a raw text address › Request Body

string

Parse a raw text address › Responses

Address parsing started successfully

  • successboolean · required
  • metadataobject · required
  • statusstring · required

    Descriptive status message

  • dataobject

Parse CSV into structured JSON

POST
https://api.cloudharness.com
/v1/parse/csv

Parses CSV data into a structured JSON array of objects (header row required by default).

Parse CSV into structured JSON › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Parse CSV into structured JSON › Request Body

string

CSV data with headers

Parse CSV into structured JSON › Responses

Successfully parsed CSV data

  • successboolean · required
  • metadataobject · required
  • statusstring · required

    Descriptive status message

  • dataobject[]

Get address parsing status/result

GET
https://api.cloudharness.com
/v1/parse/address/{responseId}

Retrieves the status and result of a previously parsed address by response ID. If the original parsing was synchronous and did not return a response ID, this endpoint may return 404.

Get address parsing status/result › path Parameters

  • responseIdstring · required

    The response ID of the address parsing job to retrieve

Get address parsing status/result › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get address parsing status/result › Responses

Address parsing completed successfully

  • successboolean · required
  • metadataobject · required
  • statusstring · required

    Descriptive status message

  • dataobject
ConduitReports