TO MAKE THE API CALL

1. Click POST to display all the Swagger operations.

2. Click Try it out to enable the fields.

3. Paste your access-token (API Key) into the x-ag-access-token field.

If you do not already have a token, register for MyRefinitiv, and then login to PermID.org with your new credentials. An Open Calais API Key is automatically e-mailed to you. 

Subsequently, the key is displayed on https://permid.org under APIs > Display my API token.

4. Optionally, enter the metadata types relevant to your use case in the x-calais-selectiveTags field. Read this for details about the soon-to-be mandatory header and for the list of valid values.

5. Paste text into the Text field.

6. Optionally, enter a value in the x-calais-language field (English, Chinese, French, German, Japanese, or Spanish).

7. Set the outputFormat (xml/rdf, application/json, or text/n3).

8. Click Execute to send the request.

THE API RESPONSE INCLUDES THE FOLLOWING

Response Code: Indicates the status of the request you sent. If everything went fine the returned code should be "200," meaning the request has been handled successfully by the server.

Response Body: Contains all of the metadata extracted by Intelligent Tagging from the input text.

For a detailed description of the API response and each metadata type, please see the API User Guide.