Profiles.Generate ▷ Description Generate a new profile.
Argument route: workflow route to emulate one of: "patent_list" "claim_chart" "mlt_text" "fto" "mining" "company_profile" "patent_pool" patent_list: array of patent ids. The format for a given patent is very flexible, e.g. "5396718", "US-5396718-A", "US9507867B2" claim_chart: patent id clusters: number of clusters: 0 - do not cluster whole number - number of clusters (maximum) (missing) - determine the number of clusters dynamically claims_inclusion: 0 - do not include the claims in any product analysis 1 - first claim only 2 - all independent claims 3 - all claims 4 - sample of claims (for very large patent collections) comments: free form comments that describe the profile callback_url: This should be a URL on your server. It will be called upon the completion of the profile. The POST of the HTTP call to this URL is JSON. Its structure is the same as that shown below in the example response. The "status" will be "complete" if there are no issues. While it is recommended that you supply this URL, you don't have to; you can poll for the completed profile yourself, e.g. every 60 seconds or so, by calling method Profile.Get.
Result key: The unique key of the profile. This key can then be passed to other methods. status: one of: "pending" "complete" "error" This should normally be "pending" but if you call Profile.Generate for a profile that already exists, you could get any of the statuses shown above.
Example
REQUEST: { "patent_list": ["US-5396718-A", "US-9507867-B2", "..."] }
RESPONSE: { "success": true, "result": { "key": "jJWNjljYxMTNhFDOzYTO3YTZlZD...", "status": "pending" } }
| Profiles.Get ▷ Description Get the content of a profile.
Argument key: key of the profile
Result status: one of: "" "pending" "complete" "error" content: This is a very complex data structure that will be documented soon. Until then, just have a look at a result of this method. error: error message (in result only if "status" is "error")
Example
REQUEST: { "key": "jJWNjljYxMTNhFDOzYTO3YTZlZD..." }
RESPONSE: { "success": true, "result": { "status": "complete", "content": { "input": {...}, "output": {...} } } }
|
Profiles.List ▷ Description List profiles that you have created.
Argument route: Return profiles created with the specified route (see Profile.Generate). If not passed, return all of your profiles.
Result profiles: array of records, each with the following properties: key - unique key of the profile status - one of: "pending" "complete" "error" route - (see method Profile.Generate) comments - (see method Profile.Generate) creation-timestamp - creation timestamp (W3C format) completion-timestamp - completion timestamp (W3C format)
Example
REQUEST: { "route": "claim_chart" }
RESPONSE: { "success": true, "result": { "profiles": [ { "key": "jJWNjljYxMTNhFDOzYTO3YTZlZD...", "status": "complete", "route": "claim_chart", "comments": "my first profile", "creation-timestamp": "2024-04-02T16:25:18.055Z", "completion-timestamp": "2024-04-02T16:40:07.003Z" }, { ... } ] } }
| Profiles.Remove ▷ Description Remove a profile.
Argument key: key of the profile to remove
Result state: 1 - successfully removed 0 - the key does not exist (did not have to be removed) -1 - the key could not be removed (should "never" happen)
Example
REQUEST: { "key": "jJWNjljYxMTNhFDOzYTO3YTZlZD..." }
RESPONSE: { "success": true, "result": { "state": 1 } }
|
Profiles.URL ▷ Description Get the URL of a profile.
Argument key: key of the profile type: type of content that the URL should return one of: "source", "base", "full", "ratings", ... (more documentation coming soon) Default: "source"
Result url: URL that returns the content requested. You can see the format of the URL so that you don't actually have to call the Profile.URL method again.
Example
REQUEST: { "key": "jJWNjljYxMTNhFDOzYTO3YTZlZD...", "type": "source" }
RESPONSE: { "success": true, "result": { "url": "https://ip-profile.com/Profile?type=source&key=xQmN2EDZ4Y..." } }
| Patents.Cluster ▷ Description Cluster some patents into mutually exclusive groups.
Argument patents: array of patents to cluster. Format of a patent, by example: US-9000000-B2 Any reasonable format can be used though. maximum_groups: maximum number of groups to cluster the patents into. If not specified, a reasonably conservative number will be utilized.
Result groups: array of groups where each group contains an array of patents. The length of this array is less than or equal to "maximum_groups".
Example
REQUEST: { "patents": ["US-9000000-B2", "US-9000001-B2", ...], "maximum_groups": 10 }
RESPONSE: { "success": true, "result": { "groups": [ ["US-9000000-B2", "US-9000001-B2", ...], ["US-8000000-B2", "US-8000001-B2", ...], ... ] } }
|
GetAuthToken ▷ Description Generate an authorization token for use in a signed-URL.
Argument user_id: a user id that the token is being used on behalf of timeout: number of seconds beyond which the token expires. Default: 600
Result auth_token: a token as a string
Example
REQUEST: { "user_id": "xyz@domain.com", "timeout": 300 }
RESPONSE: { "success": true, "result": { "auth_token": "LbEdyNSD6rLyAHeNZEyrVjDBJLN..." } }
| AST.GetTechnologyCategories ▷ Description For some patent or description, get technology categories for it that are specific to Allied Security Trust. This method shows in the API documentation only if signed in as "@ast.com".
Argument patent-number: US Patent Grant number The format for a given patent is very flexible, e.g. "5396718", "US-5396718-A", "US9507867B2". If passed, this is used instead of "desription" (see below). description: any sort of description of the patent, e.g. abstract, claims
Result array of technology categories, where each element has the following properties: category: technology category for AST score: score on a scale of 1-10
Example
REQUEST: { "patent-number": "US-9507867-B2" }
RESPONSE: { "success": true, "result": [ { "category": "Database: Database Search", "score": 9 }, { "category": "Data: Data Processing", "score": 8 }, { "category": "Software: Data Intelligence & Analytics", "score": 7 }, { "category": "Software: Text Processing", "score": 7 } ] }
|
AST.GetProductCategories ▷ Description For some patent or description, get product categories for it that are specific to Allied Security Trust. This method shows in the API documentation only if signed in as "@ast.com".
Argument patent-number: US Patent Grant number The format for a given patent is very flexible, e.g. "5396718", "US-5396718-A", "US9507867B2". If passed, this is used instead of "desription" (see below). description: any sort of description of the patent, e.g. abstract, claims
Result array of product categories, where each element has the following properties: category: product category for AST score: score on a scale of 1-10
Example
REQUEST: { "patent-number": "US-9507867-B2" }
RESPONSE: { "success": true, "result": [ { "category": "...", "score": 9 }, { "category": "...", "score": 8 } ] }
| |